Партнерский API Маркета

Bids

getBidsInfoForBusiness

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/info

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BidsApi;

import java.io.File;
import java.util.*;

public class BidsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | 

try {
    final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}

import org.openapitools.client.api.BidsApi;

public class BidsApiExample {
    public static void main(String[] args) {
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BidsApi *apiInstance = [[BidsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; //  (optional)

// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
    pageToken:pageToken
    limit:limit
    getBidsInfoRequest:getBidsInfoRequest
              completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BidsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getBidsInfoRequest':  // {GetBidsInfoRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsInfoForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BidsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |  (optional) 

            try {
                // Информация об установленных ставках
                GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BidsApi.getBidsInfoForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BidsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getBidsInfoRequest = ; // GetBidsInfoRequest | 

try {
    $result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BidsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BidsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest | 

eval {
    my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BidsApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BidsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getBidsInfoRequest =  # GetBidsInfoRequest |  (optional)

try:
    # Информация об установленных ставках
    api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BidsApi->getBidsInfoForBusiness: %s\n" % e)
extern crate BidsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getBidsInfoRequest = ; // GetBidsInfoRequest

    let mut context = BidsApi::Context::default();
    let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsInfoRequest

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBidsRecommendations

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BidsApi;

import java.io.File;
import java.util.*;

public class BidsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetBidsRecommendationsRequest getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

try {
    final result = await api_instance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsRecommendations: $e\n');
}

import org.openapitools.client.api.BidsApi;

public class BidsApiExample {
    public static void main(String[] args) {
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BidsApi *apiInstance = [[BidsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetBidsRecommendationsRequest *getBidsRecommendationsRequest = ; // 

// Рекомендованные ставки для заданных товаров
[apiInstance getBidsRecommendationsWith:businessId
    getBidsRecommendationsRequest:getBidsRecommendationsRequest
              completionHandler: ^(GetBidsRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BidsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getBidsRecommendationsRequest = ; // {GetBidsRecommendationsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsRecommendations(businessId, getBidsRecommendationsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BidsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

            try {
                // Рекомендованные ставки для заданных товаров
                GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BidsApi.getBidsRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BidsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

try {
    $result = $api_instance->getBidsRecommendations($businessId, $getBidsRecommendationsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BidsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BidsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getBidsRecommendationsRequest = WWW::OPenAPIClient::Object::GetBidsRecommendationsRequest->new(); # GetBidsRecommendationsRequest | 

eval {
    my $result = $api_instance->getBidsRecommendations(businessId => $businessId, getBidsRecommendationsRequest => $getBidsRecommendationsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BidsApi->getBidsRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BidsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getBidsRecommendationsRequest =  # GetBidsRecommendationsRequest | 

try:
    # Рекомендованные ставки для заданных товаров
    api_response = api_instance.get_bids_recommendations(businessId, getBidsRecommendationsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BidsApi->getBidsRecommendations: %s\n" % e)
extern crate BidsApi;

pub fn main() {
    let businessId = 789; // Long
    let getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest

    let mut context = BidsApi::Context::default();
    let result = client.getBidsRecommendations(businessId, getBidsRecommendationsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsRecommendationsRequest *

description.

Responses


putBidsForBusiness

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} ![](../../_images/api-boost.png) {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BidsApi;

import java.io.File;
import java.util.*;

public class BidsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForBusiness(businessId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForBusiness: $e\n');
}

import org.openapitools.client.api.BidsApi;

public class BidsApiExample {
    public static void main(String[] args) {
        BidsApi apiInstance = new BidsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BidsApi *apiInstance = [[BidsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок
[apiInstance putBidsForBusinessWith:businessId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BidsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForBusiness(businessId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BidsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок
                EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BidsApi.putBidsForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BidsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForBusiness($businessId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BidsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BidsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForBusiness(businessId => $businessId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BidsApi->putBidsForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BidsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок
    api_response = api_instance.put_bids_for_business(businessId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BidsApi->putBidsForBusiness: %s\n" % e)
extern crate BidsApi;

pub fn main() {
    let businessId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = BidsApi::Context::default();
    let result = client.putBidsForBusiness(businessId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


putBidsForCampaign

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или [PUT businesses/{businessId}/bids](/reference/bids/putBidsForBusiness). Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/campaigns/{campaignId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BidsApi;

import java.io.File;
import java.util.*;

public class BidsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BidsApi apiInstance = new BidsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForCampaign(campaignId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForCampaign: $e\n');
}

import org.openapitools.client.api.BidsApi;

public class BidsApiExample {
    public static void main(String[] args) {
        BidsApi apiInstance = new BidsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BidsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BidsApi *apiInstance = [[BidsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок для магазина
[apiInstance putBidsForCampaignWith:campaignId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BidsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForCampaign(campaignId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BidsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок для магазина
                EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BidsApi.putBidsForCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BidsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForCampaign($campaignId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BidsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BidsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForCampaign(campaignId => $campaignId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BidsApi->putBidsForCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BidsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок для магазина
    api_response = api_instance.put_bids_for_campaign(campaignId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BidsApi->putBidsForCampaign: %s\n" % e)
extern crate BidsApi;

pub fn main() {
    let campaignId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = BidsApi::Context::default();
    let result = client.putBidsForCampaign(campaignId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


BusinessOfferMappings

addOffersToArchive

Добавление товаров в архив

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета. {% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %} Вначале такой товар нужно распродать или вывезти. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/archive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/archive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddOffersToArchiveRequest addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

try {
    final result = await api_instance.addOffersToArchive(businessId, addOffersToArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOffersToArchive: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddOffersToArchiveRequest *addOffersToArchiveRequest = ; // 

// Добавление товаров в архив
[apiInstance addOffersToArchiveWith:businessId
    addOffersToArchiveRequest:addOffersToArchiveRequest
              completionHandler: ^(AddOffersToArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addOffersToArchiveRequest = ; // {AddOffersToArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOffersToArchive(businessId, addOffersToArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addOffersToArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

            try {
                // Добавление товаров в архив
                AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.addOffersToArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

try {
    $result = $api_instance->addOffersToArchive($businessId, $addOffersToArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->addOffersToArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addOffersToArchiveRequest = WWW::OPenAPIClient::Object::AddOffersToArchiveRequest->new(); # AddOffersToArchiveRequest | 

eval {
    my $result = $api_instance->addOffersToArchive(businessId => $businessId, addOffersToArchiveRequest => $addOffersToArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->addOffersToArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addOffersToArchiveRequest =  # AddOffersToArchiveRequest | 

try:
    # Добавление товаров в архив
    api_response = api_instance.add_offers_to_archive(businessId, addOffersToArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->addOffersToArchive: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let addOffersToArchiveRequest = ; // AddOffersToArchiveRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.addOffersToArchive(businessId, addOffersToArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addOffersToArchiveRequest *

Responses


deleteOffers

Удаление товаров из каталога

Удаляет товары из каталога. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersRequest deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

try {
    final result = await api_instance.deleteOffers(businessId, deleteOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffers: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersRequest *deleteOffersRequest = ; // 

// Удаление товаров из каталога
[apiInstance deleteOffersWith:businessId
    deleteOffersRequest:deleteOffersRequest
              completionHandler: ^(DeleteOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersRequest = ; // {DeleteOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffers(businessId, deleteOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

            try {
                // Удаление товаров из каталога
                DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.deleteOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersRequest = ; // DeleteOffersRequest | 

try {
    $result = $api_instance->deleteOffers($businessId, $deleteOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->deleteOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersRequest = WWW::OPenAPIClient::Object::DeleteOffersRequest->new(); # DeleteOffersRequest | 

eval {
    my $result = $api_instance->deleteOffers(businessId => $businessId, deleteOffersRequest => $deleteOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->deleteOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersRequest =  # DeleteOffersRequest | 

try:
    # Удаление товаров из каталога
    api_response = api_instance.delete_offers(businessId, deleteOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->deleteOffers: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersRequest = ; // DeleteOffersRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.deleteOffers(businessId, deleteOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersRequest *

Responses


deleteOffersFromArchive

Удаление товаров из архива

Восстанавливает товары из архива. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/unarchive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/unarchive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

try {
    final result = await api_instance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffersFromArchive: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersFromArchiveRequest *deleteOffersFromArchiveRequest = ; // 

// Удаление товаров из архива
[apiInstance deleteOffersFromArchiveWith:businessId
    deleteOffersFromArchiveRequest:deleteOffersFromArchiveRequest
              completionHandler: ^(DeleteOffersFromArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersFromArchiveRequest = ; // {DeleteOffersFromArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersFromArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

            try {
                // Удаление товаров из архива
                DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.deleteOffersFromArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

try {
    $result = $api_instance->deleteOffersFromArchive($businessId, $deleteOffersFromArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->deleteOffersFromArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersFromArchiveRequest = WWW::OPenAPIClient::Object::DeleteOffersFromArchiveRequest->new(); # DeleteOffersFromArchiveRequest | 

eval {
    my $result = $api_instance->deleteOffersFromArchive(businessId => $businessId, deleteOffersFromArchiveRequest => $deleteOffersFromArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->deleteOffersFromArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersFromArchiveRequest =  # DeleteOffersFromArchiveRequest | 

try:
    # Удаление товаров из архива
    api_response = api_instance.delete_offers_from_archive(businessId, deleteOffersFromArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->deleteOffersFromArchive: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersFromArchiveRequest *

Responses


getOfferMappings

Информация о товарах в каталоге

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара. Можно использовать тремя способами: * задать список интересующих SKU; * задать фильтр — в этом случае результаты возвращаются постранично; * не передавать тело запроса, чтобы получить список всех товаров в каталоге. |**⚙️ Лимит:** 600 запросов в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferMappingsRequest getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest | 

try {
    final result = await api_instance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappings: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferMappingsRequest *getOfferMappingsRequest = ; //  (optional)

// Информация о товарах в каталоге
[apiInstance getOfferMappingsWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferMappingsRequest:getOfferMappingsRequest
              completionHandler: ^(GetOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferMappingsRequest':  // {GetOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest |  (optional) 

            try {
                // Информация о товарах в каталоге
                GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.getOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

try {
    $result = $api_instance->getOfferMappings($businessId, $pageToken, $limit, $getOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->getOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferMappingsRequest = WWW::OPenAPIClient::Object::GetOfferMappingsRequest->new(); # GetOfferMappingsRequest | 

eval {
    my $result = $api_instance->getOfferMappings(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferMappingsRequest => $getOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->getOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferMappingsRequest =  # GetOfferMappingsRequest |  (optional)

try:
    # Информация о товарах в каталоге
    api_response = api_instance.get_offer_mappings(businessId, pageToken=pageToken, limit=limit, getOfferMappingsRequest=getOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->getOfferMappings: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferMappingsRequest = ; // GetOfferMappingsRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferMappingsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappings

Просмотр карточек на Маркете, которые подходят вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами. Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным. **Как пользоваться запросом** 1. Передайте Маркету список товаров, которые нужно проверить. 2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией. 3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида `https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>`. 4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать `marketSKU`, который ему подходит по вашему мнению. {% note info "𝓠 Как определить `marketSku` товара, найденного на Маркете?" %} 𝓐 Он есть в адресе страницы товара — расположен после `sku=`. Например, `https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016` {% endnote %} |**⚙️ Лимит:** 100 000 товаров в час| |-|


/businesses/{businessId}/offer-mappings/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/suggestions" \
 -d '{
  "offers" : [ {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappings: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingsRequest *getSuggestedOfferMappingsRequest = ; //  (optional)

// Просмотр карточек на Маркете, которые подходят вашим товарам
[apiInstance getSuggestedOfferMappingsWith:businessId
    getSuggestedOfferMappingsRequest:getSuggestedOfferMappingsRequest
              completionHandler: ^(GetSuggestedOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getSuggestedOfferMappingsRequest':  // {GetSuggestedOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest |  (optional) 

            try {
                // Просмотр карточек на Маркете, которые подходят вашим товарам
                GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.getSuggestedOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappings($businessId, $getSuggestedOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->getSuggestedOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingsRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingsRequest->new(); # GetSuggestedOfferMappingsRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappings(businessId => $businessId, getSuggestedOfferMappingsRequest => $getSuggestedOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->getSuggestedOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingsRequest =  # GetSuggestedOfferMappingsRequest |  (optional)

try:
    # Просмотр карточек на Маркете, которые подходят вашим товарам
    api_response = api_instance.get_suggested_offer_mappings(businessId, getSuggestedOfferMappingsRequest=getSuggestedOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->getSuggestedOfferMappings: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingsRequest

Responses


updateOfferMappings

Добавление товаров в каталог и изменение информации о них

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах. Список категорий Маркета можно получить с помощью запроса [POST categories/tree](../../reference/categories/getCategoriesTree.md), а характеристики товаров по категориям с помощью [POST category/{categoryId}/parameters](../../reference/content/getCategoryContentParameters.md). Чтобы **добавить новый товар**, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (**SKU на Маркете**) в поле `marketSKU`. Для **новых товаров** обязательно укажите параметры: `offerId`, `name`, `marketCategoryId` или `category`, `pictures`, `vendor`, `description`. Чтобы **отредактировать информацию о товаре**, передайте новые данные, указав в `offerId` соответствующий **ваш SKU**. Поля, в которых ничего не меняется, можно не передавать. Чтобы **удалить характеристики**, которые заданы в параметрах с типом `string`, передайте пустое значение. Параметр `offerId` должен быть **уникальным** для всех товаров, которые вы передаете. {% note warning "Правила использования SKU" %} * У каждого товара SKU должен быть свой. * SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. * Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update" \
 -d '{
  "offerMappings" : [ {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  } ],
  "onlyPartnerMediaContent" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessOfferMappingsApi;

import java.io.File;
import java.util.*;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingsRequest updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

try {
    final result = await api_instance.updateOfferMappings(businessId, updateOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappings: $e\n');
}

import org.openapitools.client.api.BusinessOfferMappingsApi;

public class BusinessOfferMappingsApiExample {
    public static void main(String[] args) {
        BusinessOfferMappingsApi apiInstance = new BusinessOfferMappingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessOfferMappingsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessOfferMappingsApi *apiInstance = [[BusinessOfferMappingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingsRequest *updateOfferMappingsRequest = ; // 

// Добавление товаров в каталог и изменение информации о них
[apiInstance updateOfferMappingsWith:businessId
    updateOfferMappingsRequest:updateOfferMappingsRequest
              completionHandler: ^(UpdateOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessOfferMappingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingsRequest = ; // {UpdateOfferMappingsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappings(businessId, updateOfferMappingsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessOfferMappingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

            try {
                // Добавление товаров в каталог и изменение информации о них
                UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessOfferMappingsApi.updateOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessOfferMappingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

try {
    $result = $api_instance->updateOfferMappings($businessId, $updateOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessOfferMappingsApi->updateOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessOfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessOfferMappingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingsRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingsRequest->new(); # UpdateOfferMappingsRequest | 

eval {
    my $result = $api_instance->updateOfferMappings(businessId => $businessId, updateOfferMappingsRequest => $updateOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessOfferMappingsApi->updateOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessOfferMappingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingsRequest =  # UpdateOfferMappingsRequest | 

try:
    # Добавление товаров в каталог и изменение информации о них
    api_response = api_instance.update_offer_mappings(businessId, updateOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessOfferMappingsApi->updateOfferMappings: %s\n" % e)
extern crate BusinessOfferMappingsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest

    let mut context = BusinessOfferMappingsApi::Context::default();
    let result = client.updateOfferMappings(businessId, updateOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingsRequest *

Responses


Businesses

getBusinessSettings

Настройки кабинета

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/settings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BusinessesApi;

import java.io.File;
import java.util.*;

public class BusinessesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        BusinessesApi apiInstance = new BusinessesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessesApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getBusinessSettings(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessSettings: $e\n');
}

import org.openapitools.client.api.BusinessesApi;

public class BusinessesApiExample {
    public static void main(String[] args) {
        BusinessesApi apiInstance = new BusinessesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessesApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BusinessesApi *apiInstance = [[BusinessesApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки кабинета
[apiInstance getBusinessSettingsWith:businessId
              completionHandler: ^(GetBusinessSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.BusinessesApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessSettings(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BusinessesApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки кабинета
                GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BusinessesApi.getBusinessSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BusinessesApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getBusinessSettings($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessesApi->getBusinessSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BusinessesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BusinessesApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getBusinessSettings(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessesApi->getBusinessSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BusinessesApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки кабинета
    api_response = api_instance.get_business_settings(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessesApi->getBusinessSettings: %s\n" % e)
extern crate BusinessesApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = BusinessesApi::Context::default();
    let result = client.getBusinessSettings(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


Campaigns

getCampaign

Информация о магазине

Возвращает информацию о магазине. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaign(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaign: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Информация о магазине
[apiInstance getCampaignWith:campaignId
              completionHandler: ^(GetCampaignResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Информация о магазине
                GetCampaignResponse result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Информация о магазине
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaign: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignLogins

Логины, связанные с магазином

Возвращает список логинов, у которых есть доступ к магазину. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/logins

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/logins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignLogins(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignLogins: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Логины, связанные с магазином
[apiInstance getCampaignLoginsWith:campaignId
              completionHandler: ^(GetCampaignLoginsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignLogins(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignLoginsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Логины, связанные с магазином
                GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaignLogins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignLogins($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaignLogins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignLogins(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaignLogins: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Логины, связанные с магазином
    api_response = api_instance.get_campaign_logins(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaignLogins: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaignLogins(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignRegion

Регион магазина

{% note warning "" %} Этот метод устарел. Вместо него используйте [GET campaigns/{campaignId}/settings](../../reference/campaigns/getCampaignSettings.md). {% endnote %} Возвращает регион, в котором находится магазин. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/campaigns/{campaignId}/region

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignRegion(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignRegion: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Регион магазина
[apiInstance getCampaignRegionWith:campaignId
              completionHandler: ^(GetCampaignRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignRegion(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignRegionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Регион магазина
                GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaignRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignRegion($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaignRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignRegion(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaignRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Регион магазина
    api_response = api_instance.get_campaign_region(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaignRegion: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaignRegion(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignSettings

Настройки магазина

Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/settings

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignSettings(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignSettings: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки магазина
[apiInstance getCampaignSettingsWith:campaignId
              completionHandler: ^(GetCampaignSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignSettings(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки магазина
                GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaignSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignSettings($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaignSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignSettings(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaignSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки магазина
    api_response = api_instance.get_campaign_settings(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaignSettings: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaignSettings(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaigns

Список магазинов пользователя

Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaigns(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaigns: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Список магазинов пользователя
[apiInstance getCampaignsWith:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaigns(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Список магазинов пользователя
                GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaigns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaigns($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaigns(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Список магазинов пользователя
    api_response = api_instance.get_campaigns(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaigns: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaigns(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCampaignsByLogin

Магазины, доступные логину

Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/by_login/{login}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/by_login/{login}?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String login = new String(); // String | Логин пользователя.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaignsByLogin(login, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignsByLogin: $e\n');
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
String *login = login_example; // Логин пользователя. (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Магазины, доступные логину
[apiInstance getCampaignsByLoginWith:login
    page:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CampaignsApi()
var login = login_example; // {String} Логин пользователя.
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignsByLogin(login, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsByLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var login = login_example;  // String | Логин пользователя. (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Магазины, доступные логину
                GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaignsByLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$login = login_example; // String | Логин пользователя.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaignsByLogin($login, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaignsByLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $login = login_example; # String | Логин пользователя.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaignsByLogin(login => $login, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaignsByLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
login = login_example # String | Логин пользователя. (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Магазины, доступные логину
    api_response = api_instance.get_campaigns_by_login(login, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaignsByLogin: %s\n" % e)
extern crate CampaignsApi;

pub fn main() {
    let login = login_example; // String
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaignsByLogin(login, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
login*
String
Логин пользователя.
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


Categories

getCategoriesMaxSaleQuantum

Лимит на установку кванта продажи и минимального количества товаров в заказе

Возвращает лимит на установку [кванта](*quantum) и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий. Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины. Подробнее о том, как продавать товары по несколько штук, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/fields/quantum). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/max-sale-quantum

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/max-sale-quantum" \
 -d '{
  "marketCategoryIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CategoriesApi;

import java.io.File;
import java.util.*;

public class CategoriesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CategoriesApi apiInstance = new CategoriesApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

try {
    final result = await api_instance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesMaxSaleQuantum: $e\n');
}

import org.openapitools.client.api.CategoriesApi;

public class CategoriesApiExample {
    public static void main(String[] args) {
        CategoriesApi apiInstance = new CategoriesApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CategoriesApi *apiInstance = [[CategoriesApi alloc] init];
GetCategoriesMaxSaleQuantumRequest *getCategoriesMaxSaleQuantumRequest = ; // 

// Лимит на установку кванта продажи и минимального количества товаров в заказе
[apiInstance getCategoriesMaxSaleQuantumWith:getCategoriesMaxSaleQuantumRequest
              completionHandler: ^(GetCategoriesMaxSaleQuantumResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CategoriesApi()
var getCategoriesMaxSaleQuantumRequest = ; // {GetCategoriesMaxSaleQuantumRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesMaxSaleQuantumExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CategoriesApi();
            var getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

            try {
                // Лимит на установку кванта продажи и минимального количества товаров в заказе
                GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CategoriesApi.getCategoriesMaxSaleQuantum: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CategoriesApi();
$getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

try {
    $result = $api_instance->getCategoriesMaxSaleQuantum($getCategoriesMaxSaleQuantumRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoriesApi->getCategoriesMaxSaleQuantum: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CategoriesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CategoriesApi->new();
my $getCategoriesMaxSaleQuantumRequest = WWW::OPenAPIClient::Object::GetCategoriesMaxSaleQuantumRequest->new(); # GetCategoriesMaxSaleQuantumRequest | 

eval {
    my $result = $api_instance->getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest => $getCategoriesMaxSaleQuantumRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CategoriesApi->getCategoriesMaxSaleQuantum: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CategoriesApi()
getCategoriesMaxSaleQuantumRequest =  # GetCategoriesMaxSaleQuantumRequest | 

try:
    # Лимит на установку кванта продажи и минимального количества товаров в заказе
    api_response = api_instance.get_categories_max_sale_quantum(getCategoriesMaxSaleQuantumRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->getCategoriesMaxSaleQuantum: %s\n" % e)
extern crate CategoriesApi;

pub fn main() {
    let getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest

    let mut context = CategoriesApi::Context::default();
    let result = client.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesMaxSaleQuantumRequest *

Responses


getCategoriesTree

Дерево категорий

Возвращает дерево категорий Маркета. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/tree

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/tree" \
 -d '{
  "language" : "RU"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CategoriesApi;

import java.io.File;
import java.util.*;

public class CategoriesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CategoriesApi apiInstance = new CategoriesApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesRequest getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest | 

try {
    final result = await api_instance.getCategoriesTree(getCategoriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesTree: $e\n');
}

import org.openapitools.client.api.CategoriesApi;

public class CategoriesApiExample {
    public static void main(String[] args) {
        CategoriesApi apiInstance = new CategoriesApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CategoriesApi *apiInstance = [[CategoriesApi alloc] init];
GetCategoriesRequest *getCategoriesRequest = ; //  (optional)

// Дерево категорий
[apiInstance getCategoriesTreeWith:getCategoriesRequest
              completionHandler: ^(GetCategoriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.CategoriesApi()
var opts = {
  'getCategoriesRequest':  // {GetCategoriesRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesTree(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesTreeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CategoriesApi();
            var getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest |  (optional) 

            try {
                // Дерево категорий
                GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CategoriesApi.getCategoriesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CategoriesApi();
$getCategoriesRequest = ; // GetCategoriesRequest | 

try {
    $result = $api_instance->getCategoriesTree($getCategoriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoriesApi->getCategoriesTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CategoriesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CategoriesApi->new();
my $getCategoriesRequest = WWW::OPenAPIClient::Object::GetCategoriesRequest->new(); # GetCategoriesRequest | 

eval {
    my $result = $api_instance->getCategoriesTree(getCategoriesRequest => $getCategoriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CategoriesApi->getCategoriesTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CategoriesApi()
getCategoriesRequest =  # GetCategoriesRequest |  (optional)

try:
    # Дерево категорий
    api_response = api_instance.get_categories_tree(getCategoriesRequest=getCategoriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->getCategoriesTree: %s\n" % e)
extern crate CategoriesApi;

pub fn main() {
    let getCategoriesRequest = ; // GetCategoriesRequest

    let mut context = CategoriesApi::Context::default();
    let result = client.getCategoriesTree(getCategoriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesRequest

Responses


Chats

createChat

Создание нового чата с покупателем

Создает новый чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/new

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/new" \
 -d '{
  "orderId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChatsApi;

import java.io.File;
import java.util.*;

public class ChatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#createChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final CreateChatRequest createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

try {
    final result = await api_instance.createChat(businessId, createChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createChat: $e\n');
}

import org.openapitools.client.api.ChatsApi;

public class ChatsApiExample {
    public static void main(String[] args) {
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#createChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ChatsApi *apiInstance = [[ChatsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
CreateChatRequest *createChatRequest = ; // 

// Создание нового чата с покупателем
[apiInstance createChatWith:businessId
    createChatRequest:createChatRequest
              completionHandler: ^(CreateChatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ChatsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var createChatRequest = ; // {CreateChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChat(businessId, createChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ChatsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

            try {
                // Создание нового чата с покупателем
                CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChatsApi.createChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChatsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$createChatRequest = ; // CreateChatRequest | 

try {
    $result = $api_instance->createChat($businessId, $createChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->createChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChatsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $createChatRequest = WWW::OPenAPIClient::Object::CreateChatRequest->new(); # CreateChatRequest | 

eval {
    my $result = $api_instance->createChat(businessId => $businessId, createChatRequest => $createChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChatsApi->createChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ChatsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
createChatRequest =  # CreateChatRequest | 

try:
    # Создание нового чата с покупателем
    api_response = api_instance.create_chat(businessId, createChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChatsApi->createChat: %s\n" % e)
extern crate ChatsApi;

pub fn main() {
    let businessId = 789; // Long
    let createChatRequest = ; // CreateChatRequest

    let mut context = ChatsApi::Context::default();
    let result = client.createChat(businessId, createChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
createChatRequest *

description

Responses


getChatHistory

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history?chatId=789&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "messageIdFrom" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChatsApi;

import java.io.File;
import java.util.*;

public class ChatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final GetChatHistoryRequest getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChatHistory: $e\n');
}

import org.openapitools.client.api.ChatsApi;

public class ChatsApiExample {
    public static void main(String[] args) {
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ChatsApi *apiInstance = [[ChatsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
GetChatHistoryRequest *getChatHistoryRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение истории сообщений в чате
[apiInstance getChatHistoryWith:businessId
    chatId:chatId
    getChatHistoryRequest:getChatHistoryRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatHistoryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ChatsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var getChatHistoryRequest = ; // {GetChatHistoryRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatHistory(businessId, chatId, getChatHistoryRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatHistoryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ChatsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение истории сообщений в чате
                GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChatsApi.getChatHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChatsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$getChatHistoryRequest = ; // GetChatHistoryRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChatHistory($businessId, $chatId, $getChatHistoryRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChatsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $getChatHistoryRequest = WWW::OPenAPIClient::Object::GetChatHistoryRequest->new(); # GetChatHistoryRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChatHistory(businessId => $businessId, chatId => $chatId, getChatHistoryRequest => $getChatHistoryRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChatsApi->getChatHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ChatsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
getChatHistoryRequest =  # GetChatHistoryRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение истории сообщений в чате
    api_response = api_instance.get_chat_history(businessId, chatId, getChatHistoryRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChatsApi->getChatHistory: %s\n" % e)
extern crate ChatsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let getChatHistoryRequest = ; // GetChatHistoryRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ChatsApi::Context::default();
    let result = client.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatHistoryRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getChats

Получение доступных чатов

Возвращает ваши чаты с покупателями. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "types" : [ "CHAT", "CHAT" ],
  "statuses" : [ "NEW", "NEW" ],
  "orderIds" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChatsApi;

import java.io.File;
import java.util.*;

public class ChatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#getChats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetChatsRequest getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChats(businessId, getChatsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChats: $e\n');
}

import org.openapitools.client.api.ChatsApi;

public class ChatsApiExample {
    public static void main(String[] args) {
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#getChats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ChatsApi *apiInstance = [[ChatsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetChatsRequest *getChatsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение доступных чатов
[apiInstance getChatsWith:businessId
    getChatsRequest:getChatsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ChatsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getChatsRequest = ; // {GetChatsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChats(businessId, getChatsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ChatsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение доступных чатов
                GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChatsApi.getChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChatsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getChatsRequest = ; // GetChatsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChats($businessId, $getChatsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->getChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChatsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getChatsRequest = WWW::OPenAPIClient::Object::GetChatsRequest->new(); # GetChatsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChats(businessId => $businessId, getChatsRequest => $getChatsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChatsApi->getChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ChatsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getChatsRequest =  # GetChatsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение доступных чатов
    api_response = api_instance.get_chats(businessId, getChatsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChatsApi->getChats: %s\n" % e)
extern crate ChatsApi;

pub fn main() {
    let businessId = 789; // Long
    let getChatsRequest = ; // GetChatsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ChatsApi::Context::default();
    let result = client.getChats(businessId, getChatsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatsRequest *

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


sendFileToChat

Отправка файла в чат

Отправляет файл в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/file/send

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/file/send?chatId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChatsApi;

import java.io.File;
import java.util.*;

public class ChatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final File file = new File(); // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    final result = await api_instance.sendFileToChat(businessId, chatId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendFileToChat: $e\n');
}

import org.openapitools.client.api.ChatsApi;

public class ChatsApiExample {
    public static void main(String[] args) {
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ChatsApi *apiInstance = [[ChatsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
File *file = BINARY_DATA_HERE; // Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

// Отправка файла в чат
[apiInstance sendFileToChatWith:businessId
    chatId:chatId
    file:file
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ChatsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var file = BINARY_DATA_HERE; // {File} Содержимое файла. Максимальный размер файла — 5 Мбайт.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFileToChat(businessId, chatId, file, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendFileToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ChatsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var file = BINARY_DATA_HERE;  // File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

            try {
                // Отправка файла в чат
                EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChatsApi.sendFileToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChatsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $api_instance->sendFileToChat($businessId, $chatId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChatsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $file = BINARY_DATA_HERE; # File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

eval {
    my $result = $api_instance->sendFileToChat(businessId => $businessId, chatId => $chatId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChatsApi->sendFileToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ChatsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
file = BINARY_DATA_HERE # File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

try:
    # Отправка файла в чат
    api_response = api_instance.send_file_to_chat(businessId, chatId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChatsApi->sendFileToChat: %s\n" % e)
extern crate ChatsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = ChatsApi::Context::default();
    let result = client.sendFileToChat(businessId, chatId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Form parameters
Name Description
file*
File (binary)
Содержимое файла. Максимальный размер файла — 5 Мбайт.
Required
Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


sendMessageToChat

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/message

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/message?chatId=789" \
 -d '{
  "message" : "message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChatsApi;

import java.io.File;
import java.util.*;

public class ChatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final SendMessageToChatRequest sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

try {
    final result = await api_instance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendMessageToChat: $e\n');
}

import org.openapitools.client.api.ChatsApi;

public class ChatsApiExample {
    public static void main(String[] args) {
        ChatsApi apiInstance = new ChatsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChatsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ChatsApi *apiInstance = [[ChatsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
SendMessageToChatRequest *sendMessageToChatRequest = ; // 

// Отправка сообщения в чат
[apiInstance sendMessageToChatWith:businessId
    chatId:chatId
    sendMessageToChatRequest:sendMessageToChatRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ChatsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var sendMessageToChatRequest = ; // {SendMessageToChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendMessageToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ChatsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

            try {
                // Отправка сообщения в чат
                EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChatsApi.sendMessageToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChatsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$sendMessageToChatRequest = ; // SendMessageToChatRequest | 

try {
    $result = $api_instance->sendMessageToChat($businessId, $chatId, $sendMessageToChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChatsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $sendMessageToChatRequest = WWW::OPenAPIClient::Object::SendMessageToChatRequest->new(); # SendMessageToChatRequest | 

eval {
    my $result = $api_instance->sendMessageToChat(businessId => $businessId, chatId => $chatId, sendMessageToChatRequest => $sendMessageToChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChatsApi->sendMessageToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ChatsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
sendMessageToChatRequest =  # SendMessageToChatRequest | 

try:
    # Отправка сообщения в чат
    api_response = api_instance.send_message_to_chat(businessId, chatId, sendMessageToChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChatsApi->sendMessageToChat: %s\n" % e)
extern crate ChatsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let sendMessageToChatRequest = ; // SendMessageToChatRequest

    let mut context = ChatsApi::Context::default();
    let result = client.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
sendMessageToChatRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


Content

getCategoryContentParameters

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |**⚙️ Лимит:** 50 категорий в минуту | |-|


/category/{categoryId}/parameters

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/category/{categoryId}/parameters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long categoryId = new Long(); // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    final result = await api_instance.getCategoryContentParameters(categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryContentParameters: $e\n');
}

import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
Long *categoryId = 789; // Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

// Списки характеристик товаров по категориям
[apiInstance getCategoryContentParametersWith:categoryId
              completionHandler: ^(GetCategoryContentParametersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ContentApi()
var categoryId = 789; // {Long} Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryContentParameters(categoryId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoryContentParametersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var categoryId = 789;  // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

            try {
                // Списки характеристик товаров по категориям
                GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getCategoryContentParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    $result = $api_instance->getCategoryContentParameters($categoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getCategoryContentParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $categoryId = 789; # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


eval {
    my $result = $api_instance->getCategoryContentParameters(categoryId => $categoryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getCategoryContentParameters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
categoryId = 789 # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

try:
    # Списки характеристик товаров по категориям
    api_response = api_instance.get_category_content_parameters(categoryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getCategoryContentParameters: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let categoryId = 789; // Long

    let mut context = ContentApi::Context::default();
    let result = client.getCategoryContentParameters(categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
categoryId*
Long (int64)
Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
Required

Responses


getOfferCardsContentStatus

Получение информации о заполненности карточек магазина

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * переданные характеристики товаров; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |**⚙️ Лимит:** 600 запросов в минуту| |-|


/businesses/{businessId}/offer-cards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ null, null, null, null, null ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest | 

try {
    final result = await api_instance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferCardsContentStatus: $e\n');
}

import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferCardsContentStatusRequest *getOfferCardsContentStatusRequest = ; //  (optional)

// Получение информации о заполненности карточек магазина
[apiInstance getOfferCardsContentStatusWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferCardsContentStatusRequest:getOfferCardsContentStatusRequest
              completionHandler: ^(GetOfferCardsContentStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ContentApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferCardsContentStatusRequest':  // {GetOfferCardsContentStatusRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferCardsContentStatus(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferCardsContentStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest |  (optional) 

            try {
                // Получение информации о заполненности карточек магазина
                GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getOfferCardsContentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

try {
    $result = $api_instance->getOfferCardsContentStatus($businessId, $pageToken, $limit, $getOfferCardsContentStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getOfferCardsContentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferCardsContentStatusRequest = WWW::OPenAPIClient::Object::GetOfferCardsContentStatusRequest->new(); # GetOfferCardsContentStatusRequest | 

eval {
    my $result = $api_instance->getOfferCardsContentStatus(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferCardsContentStatusRequest => $getOfferCardsContentStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getOfferCardsContentStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferCardsContentStatusRequest =  # GetOfferCardsContentStatusRequest |  (optional)

try:
    # Получение информации о заполненности карточек магазина
    api_response = api_instance.get_offer_cards_content_status(businessId, pageToken=pageToken, limit=limit, getOfferCardsContentStatusRequest=getOfferCardsContentStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getOfferCardsContentStatus: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest

    let mut context = ContentApi::Context::default();
    let result = client.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferCardsContentStatusRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


updateOfferContent

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Чтобы удалить характеристики, которые заданы в параметрах с типом `string`, передайте пустое значение. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/businesses/{businessId}/offer-cards/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards/update" \
 -d '{
  "offersContent" : [ {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferContentRequest updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

try {
    final result = await api_instance.updateOfferContent(businessId, updateOfferContentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferContent: $e\n');
}

import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferContentRequest *updateOfferContentRequest = ; // 

// Редактирование категорийных характеристик товара
[apiInstance updateOfferContentWith:businessId
    updateOfferContentRequest:updateOfferContentRequest
              completionHandler: ^(UpdateOfferContentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ContentApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferContentRequest = ; // {UpdateOfferContentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferContent(businessId, updateOfferContentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferContentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

            try {
                // Редактирование категорийных характеристик товара
                UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.updateOfferContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferContentRequest = ; // UpdateOfferContentRequest | 

try {
    $result = $api_instance->updateOfferContent($businessId, $updateOfferContentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferContentRequest = WWW::OPenAPIClient::Object::UpdateOfferContentRequest->new(); # UpdateOfferContentRequest | 

eval {
    my $result = $api_instance->updateOfferContent(businessId => $businessId, updateOfferContentRequest => $updateOfferContentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->updateOfferContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferContentRequest =  # UpdateOfferContentRequest | 

try:
    # Редактирование категорийных характеристик товара
    api_response = api_instance.update_offer_content(businessId, updateOfferContentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->updateOfferContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferContentRequest = ; // UpdateOfferContentRequest

    let mut context = ContentApi::Context::default();
    let result = client.updateOfferContent(businessId, updateOfferContentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferContentRequest *

Responses


Dbs

acceptOrderCancellation

Отмена заказа покупателем

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки. Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически. Если заказ уже передан службе доставки (принимает статус `DELIVERY` или `PICKUP`) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation.md). Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут. Чтобы узнать, какие заказы были отменены в статусе `DELIVERY` или `PICKUP`, отправьте запрос [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). В его URL добавьте входной параметр `onlyWaitingForCancellationApprove=true`. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене. Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически. |**⚙️ Лимит:** 500 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/cancellation/accept

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/cancellation/accept" \
 -d '{
  "reason" : "ORDER_DELIVERED",
  "accepted" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        AcceptOrderCancellationRequest acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

        try {
            EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#acceptOrderCancellation");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final AcceptOrderCancellationRequest acceptOrderCancellationRequest = new AcceptOrderCancellationRequest(); // AcceptOrderCancellationRequest | 

try {
    final result = await api_instance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->acceptOrderCancellation: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        AcceptOrderCancellationRequest acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

        try {
            EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#acceptOrderCancellation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
AcceptOrderCancellationRequest *acceptOrderCancellationRequest = ; // 

// Отмена заказа покупателем
[apiInstance acceptOrderCancellationWith:campaignId
    orderId:orderId
    acceptOrderCancellationRequest:acceptOrderCancellationRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var acceptOrderCancellationRequest = ; // {AcceptOrderCancellationRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class acceptOrderCancellationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var acceptOrderCancellationRequest = new AcceptOrderCancellationRequest(); // AcceptOrderCancellationRequest | 

            try {
                // Отмена заказа покупателем
                EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.acceptOrderCancellation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

try {
    $result = $api_instance->acceptOrderCancellation($campaignId, $orderId, $acceptOrderCancellationRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->acceptOrderCancellation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $acceptOrderCancellationRequest = WWW::OPenAPIClient::Object::AcceptOrderCancellationRequest->new(); # AcceptOrderCancellationRequest | 

eval {
    my $result = $api_instance->acceptOrderCancellation(campaignId => $campaignId, orderId => $orderId, acceptOrderCancellationRequest => $acceptOrderCancellationRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->acceptOrderCancellation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
acceptOrderCancellationRequest =  # AcceptOrderCancellationRequest | 

try:
    # Отмена заказа покупателем
    api_response = api_instance.accept_order_cancellation(campaignId, orderId, acceptOrderCancellationRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->acceptOrderCancellation: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest

    let mut context = DbsApi::Context::default();
    let result = client.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
acceptOrderCancellationRequest *

Responses


addHiddenOffers

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddHiddenOffersRequest addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

try {
    final result = await api_instance.addHiddenOffers(campaignId, addHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHiddenOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddHiddenOffersRequest *addHiddenOffersRequest = ; // 

// Скрытие товаров и настройки скрытия
[apiInstance addHiddenOffersWith:campaignId
    addHiddenOffersRequest:addHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addHiddenOffersRequest = ; // {AddHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addHiddenOffers(campaignId, addHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

            try {
                // Скрытие товаров и настройки скрытия
                EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.addHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

try {
    $result = $api_instance->addHiddenOffers($campaignId, $addHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->addHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addHiddenOffersRequest = WWW::OPenAPIClient::Object::AddHiddenOffersRequest->new(); # AddHiddenOffersRequest | 

eval {
    my $result = $api_instance->addHiddenOffers(campaignId => $campaignId, addHiddenOffersRequest => $addHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->addHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addHiddenOffersRequest =  # AddHiddenOffersRequest | 

try:
    # Скрытие товаров и настройки скрытия
    api_response = api_instance.add_hidden_offers(campaignId, addHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->addHiddenOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let addHiddenOffersRequest = ; // AddHiddenOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.addHiddenOffers(campaignId, addHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addHiddenOffersRequest *

Запрос на скрытие оферов.

Responses


addOffersToArchive

Добавление товаров в архив

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета. {% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %} Вначале такой товар нужно распродать или вывезти. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/archive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/archive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddOffersToArchiveRequest addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

try {
    final result = await api_instance.addOffersToArchive(businessId, addOffersToArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOffersToArchive: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddOffersToArchiveRequest *addOffersToArchiveRequest = ; // 

// Добавление товаров в архив
[apiInstance addOffersToArchiveWith:businessId
    addOffersToArchiveRequest:addOffersToArchiveRequest
              completionHandler: ^(AddOffersToArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addOffersToArchiveRequest = ; // {AddOffersToArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOffersToArchive(businessId, addOffersToArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addOffersToArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

            try {
                // Добавление товаров в архив
                AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.addOffersToArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

try {
    $result = $api_instance->addOffersToArchive($businessId, $addOffersToArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->addOffersToArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addOffersToArchiveRequest = WWW::OPenAPIClient::Object::AddOffersToArchiveRequest->new(); # AddOffersToArchiveRequest | 

eval {
    my $result = $api_instance->addOffersToArchive(businessId => $businessId, addOffersToArchiveRequest => $addOffersToArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->addOffersToArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addOffersToArchiveRequest =  # AddOffersToArchiveRequest | 

try:
    # Добавление товаров в архив
    api_response = api_instance.add_offers_to_archive(businessId, addOffersToArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->addOffersToArchive: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let addOffersToArchiveRequest = ; // AddOffersToArchiveRequest

    let mut context = DbsApi::Context::default();
    let result = client.addOffersToArchive(businessId, addOffersToArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addOffersToArchiveRequest *

Responses


calculateTariffs

Калькулятор стоимости услуг

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги. Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг. В запросе можно указать либо параметр `campaignId`, либо `sellingProgram`. Совместное использование параметров приведет к ошибке. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/tariffs/calculate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/tariffs/calculate" \
 -d '{
  "offers" : [ {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  } ],
  "parameters" : {
    "campaignId" : 0,
    "sellingProgram" : "FBY",
    "frequency" : "DAILY"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CalculateTariffsRequest calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

try {
    final result = await api_instance.calculateTariffs(calculateTariffsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->calculateTariffs: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
CalculateTariffsRequest *calculateTariffsRequest = ; // 

// Калькулятор стоимости услуг
[apiInstance calculateTariffsWith:calculateTariffsRequest
              completionHandler: ^(CalculateTariffsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var calculateTariffsRequest = ; // {CalculateTariffsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateTariffs(calculateTariffsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class calculateTariffsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

            try {
                // Калькулятор стоимости услуг
                CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.calculateTariffs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$calculateTariffsRequest = ; // CalculateTariffsRequest | 

try {
    $result = $api_instance->calculateTariffs($calculateTariffsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->calculateTariffs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $calculateTariffsRequest = WWW::OPenAPIClient::Object::CalculateTariffsRequest->new(); # CalculateTariffsRequest | 

eval {
    my $result = $api_instance->calculateTariffs(calculateTariffsRequest => $calculateTariffsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->calculateTariffs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
calculateTariffsRequest =  # CalculateTariffsRequest | 

try:
    # Калькулятор стоимости услуг
    api_response = api_instance.calculate_tariffs(calculateTariffsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->calculateTariffs: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let calculateTariffsRequest = ; // CalculateTariffsRequest

    let mut context = DbsApi::Context::default();
    let result = client.calculateTariffs(calculateTariffsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
calculateTariffsRequest *

Responses


confirmBusinessPrices

Удаление товара из карантина по цене в кабинете

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина. Основная цена задается в каталоге и действует во всех магазинах кабинета. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST businesses/{businessId}/price-quarantine](getBusinessQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmBusinessPrices(businessId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmBusinessPrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в кабинете
[apiInstance confirmBusinessPricesWith:businessId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmBusinessPrices(businessId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в кабинете
                EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.confirmBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmBusinessPrices($businessId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->confirmBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmBusinessPrices(businessId => $businessId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->confirmBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в кабинете
    api_response = api_instance.confirm_business_prices(businessId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->confirmBusinessPrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = DbsApi::Context::default();
    let result = client.confirmBusinessPrices(businessId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmCampaignPrices

Удаление товара из карантина по цене в магазине

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST campaigns/{campaignId}/price-quarantine](getCampaignQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmCampaignPrices(campaignId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmCampaignPrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в магазине
[apiInstance confirmCampaignPricesWith:campaignId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmCampaignPrices(campaignId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmCampaignPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в магазине
                EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.confirmCampaignPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmCampaignPrices($campaignId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->confirmCampaignPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmCampaignPrices(campaignId => $campaignId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->confirmCampaignPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в магазине
    api_response = api_instance.confirm_campaign_prices(campaignId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->confirmCampaignPrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = DbsApi::Context::default();
    let result = client.confirmCampaignPrices(campaignId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


createChat

Создание нового чата с покупателем

Создает новый чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/new

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/new" \
 -d '{
  "orderId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#createChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final CreateChatRequest createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

try {
    final result = await api_instance.createChat(businessId, createChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createChat: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#createChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
CreateChatRequest *createChatRequest = ; // 

// Создание нового чата с покупателем
[apiInstance createChatWith:businessId
    createChatRequest:createChatRequest
              completionHandler: ^(CreateChatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var createChatRequest = ; // {CreateChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChat(businessId, createChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

            try {
                // Создание нового чата с покупателем
                CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.createChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$createChatRequest = ; // CreateChatRequest | 

try {
    $result = $api_instance->createChat($businessId, $createChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->createChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $createChatRequest = WWW::OPenAPIClient::Object::CreateChatRequest->new(); # CreateChatRequest | 

eval {
    my $result = $api_instance->createChat(businessId => $businessId, createChatRequest => $createChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->createChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
createChatRequest =  # CreateChatRequest | 

try:
    # Создание нового чата с покупателем
    api_response = api_instance.create_chat(businessId, createChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->createChat: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let createChatRequest = ; // CreateChatRequest

    let mut context = DbsApi::Context::default();
    let result = client.createChat(businessId, createChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
createChatRequest *

description

Responses


createOutlet

Создание точки продаж

Создает точку продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets" \
 -d '{
  "storagePeriod" : 0,
  "address" : {
    "number" : "number",
    "km" : 6,
    "regionId" : 0,
    "city" : "city",
    "street" : "street",
    "additional" : "additional",
    "estate" : "estate",
    "block" : "block",
    "building" : "building"
  },
  "visibility" : "HIDDEN",
  "isMain" : true,
  "shopOutletCode" : "shopOutletCode",
  "name" : "name",
  "phones" : [ "phones", "phones" ],
  "type" : "DEPOT",
  "coords" : "coords",
  "workingSchedule" : {
    "scheduleItems" : [ {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    }, {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    } ],
    "workInHoliday" : true
  },
  "deliveryRules" : [ {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  }, {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#createOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ChangeOutletRequest changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

try {
    final result = await api_instance.createOutlet(campaignId, changeOutletRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createOutlet: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#createOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ChangeOutletRequest *changeOutletRequest = ; // 

// Создание точки продаж
[apiInstance createOutletWith:campaignId
    changeOutletRequest:changeOutletRequest
              completionHandler: ^(CreateOutletResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var changeOutletRequest = ; // {ChangeOutletRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOutlet(campaignId, changeOutletRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

            try {
                // Создание точки продаж
                CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.createOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$changeOutletRequest = ; // ChangeOutletRequest | 

try {
    $result = $api_instance->createOutlet($campaignId, $changeOutletRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->createOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $changeOutletRequest = WWW::OPenAPIClient::Object::ChangeOutletRequest->new(); # ChangeOutletRequest | 

eval {
    my $result = $api_instance->createOutlet(campaignId => $campaignId, changeOutletRequest => $changeOutletRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->createOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
changeOutletRequest =  # ChangeOutletRequest | 

try:
    # Создание точки продаж
    api_response = api_instance.create_outlet(campaignId, changeOutletRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->createOutlet: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let changeOutletRequest = ; // ChangeOutletRequest

    let mut context = DbsApi::Context::default();
    let result = client.createOutlet(campaignId, changeOutletRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
changeOutletRequest *

Responses


deleteCampaignOffers

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteCampaignOffersRequest deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

try {
    final result = await api_instance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteCampaignOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteCampaignOffersRequest *deleteCampaignOffersRequest = ; // 

// Удаление товаров из ассортимента магазина
[apiInstance deleteCampaignOffersWith:campaignId
    deleteCampaignOffersRequest:deleteCampaignOffersRequest
              completionHandler: ^(DeleteCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteCampaignOffersRequest = ; // {DeleteCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

            try {
                // Удаление товаров из ассортимента магазина
                DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

try {
    $result = $api_instance->deleteCampaignOffers($campaignId, $deleteCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteCampaignOffersRequest = WWW::OPenAPIClient::Object::DeleteCampaignOffersRequest->new(); # DeleteCampaignOffersRequest | 

eval {
    my $result = $api_instance->deleteCampaignOffers(campaignId => $campaignId, deleteCampaignOffersRequest => $deleteCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteCampaignOffersRequest =  # DeleteCampaignOffersRequest | 

try:
    # Удаление товаров из ассортимента магазина
    api_response = api_instance.delete_campaign_offers(campaignId, deleteCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteCampaignOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteCampaignOffersRequest *

Responses


deleteGoodsFeedbackComment

Удаление комментария к отзыву

Удаляет комментарий магазина. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/delete" \
 -d '{
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteGoodsFeedbackCommentRequest *deleteGoodsFeedbackCommentRequest = ; // 

// Удаление комментария к отзыву
[apiInstance deleteGoodsFeedbackCommentWith:businessId
    deleteGoodsFeedbackCommentRequest:deleteGoodsFeedbackCommentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteGoodsFeedbackCommentRequest = ; // {DeleteGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

            try {
                // Удаление комментария к отзыву
                EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->deleteGoodsFeedbackComment($businessId, $deleteGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::DeleteGoodsFeedbackCommentRequest->new(); # DeleteGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->deleteGoodsFeedbackComment(businessId => $businessId, deleteGoodsFeedbackCommentRequest => $deleteGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteGoodsFeedbackCommentRequest =  # DeleteGoodsFeedbackCommentRequest | 

try:
    # Удаление комментария к отзыву
    api_response = api_instance.delete_goods_feedback_comment(businessId, deleteGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteGoodsFeedbackComment: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest

    let mut context = DbsApi::Context::default();
    let result = client.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteGoodsFeedbackCommentRequest *

Responses


deleteHiddenOffers

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers/delete" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteHiddenOffersRequest deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

try {
    final result = await api_instance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHiddenOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteHiddenOffersRequest *deleteHiddenOffersRequest = ; // 

// Возобновление показа товаров
[apiInstance deleteHiddenOffersWith:campaignId
    deleteHiddenOffersRequest:deleteHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteHiddenOffersRequest = ; // {DeleteHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

            try {
                // Возобновление показа товаров
                EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

try {
    $result = $api_instance->deleteHiddenOffers($campaignId, $deleteHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteHiddenOffersRequest = WWW::OPenAPIClient::Object::DeleteHiddenOffersRequest->new(); # DeleteHiddenOffersRequest | 

eval {
    my $result = $api_instance->deleteHiddenOffers(campaignId => $campaignId, deleteHiddenOffersRequest => $deleteHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteHiddenOffersRequest =  # DeleteHiddenOffersRequest | 

try:
    # Возобновление показа товаров
    api_response = api_instance.delete_hidden_offers(campaignId, deleteHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteHiddenOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteHiddenOffersRequest *

Запрос на возобновление показа оферов.

Responses


deleteOffers

Удаление товаров из каталога

Удаляет товары из каталога. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersRequest deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

try {
    final result = await api_instance.deleteOffers(businessId, deleteOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersRequest *deleteOffersRequest = ; // 

// Удаление товаров из каталога
[apiInstance deleteOffersWith:businessId
    deleteOffersRequest:deleteOffersRequest
              completionHandler: ^(DeleteOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersRequest = ; // {DeleteOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffers(businessId, deleteOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

            try {
                // Удаление товаров из каталога
                DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersRequest = ; // DeleteOffersRequest | 

try {
    $result = $api_instance->deleteOffers($businessId, $deleteOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersRequest = WWW::OPenAPIClient::Object::DeleteOffersRequest->new(); # DeleteOffersRequest | 

eval {
    my $result = $api_instance->deleteOffers(businessId => $businessId, deleteOffersRequest => $deleteOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersRequest =  # DeleteOffersRequest | 

try:
    # Удаление товаров из каталога
    api_response = api_instance.delete_offers(businessId, deleteOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersRequest = ; // DeleteOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.deleteOffers(businessId, deleteOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersRequest *

Responses


deleteOffersFromArchive

Удаление товаров из архива

Восстанавливает товары из архива. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/unarchive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/unarchive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

try {
    final result = await api_instance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffersFromArchive: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersFromArchiveRequest *deleteOffersFromArchiveRequest = ; // 

// Удаление товаров из архива
[apiInstance deleteOffersFromArchiveWith:businessId
    deleteOffersFromArchiveRequest:deleteOffersFromArchiveRequest
              completionHandler: ^(DeleteOffersFromArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersFromArchiveRequest = ; // {DeleteOffersFromArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersFromArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

            try {
                // Удаление товаров из архива
                DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteOffersFromArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

try {
    $result = $api_instance->deleteOffersFromArchive($businessId, $deleteOffersFromArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteOffersFromArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersFromArchiveRequest = WWW::OPenAPIClient::Object::DeleteOffersFromArchiveRequest->new(); # DeleteOffersFromArchiveRequest | 

eval {
    my $result = $api_instance->deleteOffersFromArchive(businessId => $businessId, deleteOffersFromArchiveRequest => $deleteOffersFromArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteOffersFromArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersFromArchiveRequest =  # DeleteOffersFromArchiveRequest | 

try:
    # Удаление товаров из архива
    api_response = api_instance.delete_offers_from_archive(businessId, deleteOffersFromArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteOffersFromArchive: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest

    let mut context = DbsApi::Context::default();
    let result = client.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersFromArchiveRequest *

Responses


deleteOutlet

Удаление точки продаж

Удаляет точку продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.

try {
    final result = await api_instance.deleteOutlet(campaignId, outletId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOutlet: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)

// Удаление точки продаж
[apiInstance deleteOutletWith:campaignId
    outletId:outletId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOutlet(campaignId, outletId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)

            try {
                // Удаление точки продаж
                EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.

try {
    $result = $api_instance->deleteOutlet($campaignId, $outletId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.

eval {
    my $result = $api_instance->deleteOutlet(campaignId => $campaignId, outletId => $outletId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)

try:
    # Удаление точки продаж
    api_response = api_instance.delete_outlet(campaignId, outletId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteOutlet: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.deleteOutlet(campaignId, outletId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required

Responses


deleteOutletLicenses

Удаление лицензий для точек продаж

Удаляет информацию о лицензиях для точек продаж. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses?ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final set[Long] ids = new set[Long](); // set[Long] | Список идентификаторов лицензий.

try {
    final result = await api_instance.deleteOutletLicenses(campaignId, ids);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOutletLicenses: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deleteOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
set[Long] *ids = ; // Список идентификаторов лицензий. (optional) (default to null)

// Удаление лицензий для точек продаж
[apiInstance deleteOutletLicensesWith:campaignId
    ids:ids
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'ids':  // {set[Long]} Список идентификаторов лицензий.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOutletLicenses(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var ids = new set[Long](); // set[Long] | Список идентификаторов лицензий. (optional)  (default to null)

            try {
                // Удаление лицензий для точек продаж
                EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deleteOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$ids = ; // set[Long] | Список идентификаторов лицензий.

try {
    $result = $api_instance->deleteOutletLicenses($campaignId, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deleteOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $ids = []; # set[Long] | Список идентификаторов лицензий.

eval {
    my $result = $api_instance->deleteOutletLicenses(campaignId => $campaignId, ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deleteOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ids =  # set[Long] | Список идентификаторов лицензий. (optional) (default to null)

try:
    # Удаление лицензий для точек продаж
    api_response = api_instance.delete_outlet_licenses(campaignId, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deleteOutletLicenses: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let ids = ; // set[Long]

    let mut context = DbsApi::Context::default();
    let result = client.deleteOutletLicenses(campaignId, ids, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
ids
set[Long] (int64)
Список идентификаторов лицензий.

Responses


deletePromoOffers

Удаление товаров из акции

Убирает товары из акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete" \
 -d '{
  "deleteAllOffers" : true,
  "promoId" : "promoId",
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeletePromoOffersRequest deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

try {
    final result = await api_instance.deletePromoOffers(businessId, deletePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePromoOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeletePromoOffersRequest *deletePromoOffersRequest = ; // 

// Удаление товаров из акции
[apiInstance deletePromoOffersWith:businessId
    deletePromoOffersRequest:deletePromoOffersRequest
              completionHandler: ^(DeletePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deletePromoOffersRequest = ; // {DeletePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePromoOffers(businessId, deletePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deletePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

            try {
                // Удаление товаров из акции
                DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.deletePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

try {
    $result = $api_instance->deletePromoOffers($businessId, $deletePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->deletePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deletePromoOffersRequest = WWW::OPenAPIClient::Object::DeletePromoOffersRequest->new(); # DeletePromoOffersRequest | 

eval {
    my $result = $api_instance->deletePromoOffers(businessId => $businessId, deletePromoOffersRequest => $deletePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->deletePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deletePromoOffersRequest =  # DeletePromoOffersRequest | 

try:
    # Удаление товаров из акции
    api_response = api_instance.delete_promo_offers(businessId, deletePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->deletePromoOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deletePromoOffersRequest = ; // DeletePromoOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.deletePromoOffers(businessId, deletePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deletePromoOffersRequest *

Responses


generateBoostConsolidatedReport

Отчет по бусту продаж

Запускает генерацию **сводного отчета по бусту продаж** за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/boost-consolidated/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/boost-consolidated/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBoostConsolidatedReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateBoostConsolidatedRequest *generateBoostConsolidatedRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по бусту продаж
[apiInstance generateBoostConsolidatedReportWith:generateBoostConsolidatedRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateBoostConsolidatedRequest = ; // {GenerateBoostConsolidatedRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateBoostConsolidatedReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по бусту продаж
                GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateBoostConsolidatedReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateBoostConsolidatedReport($generateBoostConsolidatedRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateBoostConsolidatedReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateBoostConsolidatedRequest = WWW::OPenAPIClient::Object::GenerateBoostConsolidatedRequest->new(); # GenerateBoostConsolidatedRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateBoostConsolidatedReport(generateBoostConsolidatedRequest => $generateBoostConsolidatedRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateBoostConsolidatedReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateBoostConsolidatedRequest =  # GenerateBoostConsolidatedRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по бусту продаж
    api_response = api_instance.generate_boost_consolidated_report(generateBoostConsolidatedRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateBoostConsolidatedReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateBoostConsolidatedRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateCompetitorsPositionReport

Отчет «Конкурентная позиция»

Запускает генерацию **отчета «Конкурентная позиция»** за заданный период. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/analytics/competitors.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). {% note info "Значение -1 в отчете" %} Если в CSV-файле в столбце **POSITION** стоит -1, в этот день не было заказов с товарами в указанной категории. {% endnote %} |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/competitors-position/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/competitors-position/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "categoryId" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateCompetitorsPositionReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateCompetitorsPositionReportRequest *generateCompetitorsPositionReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Конкурентная позиция»
[apiInstance generateCompetitorsPositionReportWith:generateCompetitorsPositionReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateCompetitorsPositionReportRequest = ; // {GenerateCompetitorsPositionReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateCompetitorsPositionReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Конкурентная позиция»
                GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateCompetitorsPositionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateCompetitorsPositionReport($generateCompetitorsPositionReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateCompetitorsPositionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateCompetitorsPositionReportRequest = WWW::OPenAPIClient::Object::GenerateCompetitorsPositionReportRequest->new(); # GenerateCompetitorsPositionReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest => $generateCompetitorsPositionReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateCompetitorsPositionReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateCompetitorsPositionReportRequest =  # GenerateCompetitorsPositionReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Конкурентная позиция»
    api_response = api_instance.generate_competitors_position_report(generateCompetitorsPositionReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateCompetitorsPositionReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateCompetitorsPositionReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsFeedbackReport

Отчет по отзывам о товарах

Запускает генерацию **отчета по отзывам о товарах**. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/marketing/plus-reviews#stat) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-feedback/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-feedback/generate?format=" \
 -d '{
  "businessId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsFeedbackReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateGoodsFeedbackRequest *generateGoodsFeedbackRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по отзывам о товарах
[apiInstance generateGoodsFeedbackReportWith:generateGoodsFeedbackRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateGoodsFeedbackRequest = ; // {GenerateGoodsFeedbackRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsFeedbackReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по отзывам о товарах
                GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateGoodsFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsFeedbackReport($generateGoodsFeedbackRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateGoodsFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GenerateGoodsFeedbackRequest->new(); # GenerateGoodsFeedbackRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsFeedbackReport(generateGoodsFeedbackRequest => $generateGoodsFeedbackRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateGoodsFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateGoodsFeedbackRequest =  # GenerateGoodsFeedbackRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по отзывам о товарах
    api_response = api_instance.generate_goods_feedback_report(generateGoodsFeedbackRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateGoodsFeedbackReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsFeedbackRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateMassOrderLabelsReport

Готовые ярлыки‑наклейки на все коробки в нескольких заказах

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 1000 запросов в час| |-|


/reports/documents/labels/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/labels/generate?format=" \
 -d '{
  "businessId" : 0,
  "orderIds" : [ 6, 6, 6, 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    final result = await api_instance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateMassOrderLabelsReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateMassOrderLabelsRequest *generateMassOrderLabelsRequest = ; // 
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в нескольких заказах
[apiInstance generateMassOrderLabelsReportWith:generateMassOrderLabelsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateMassOrderLabelsRequest = ; // {GenerateMassOrderLabelsRequest} 
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateMassOrderLabelsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в нескольких заказах
                GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateMassOrderLabelsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    $result = $api_instance->generateMassOrderLabelsReport($generateMassOrderLabelsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateMassOrderLabelsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateMassOrderLabelsRequest = WWW::OPenAPIClient::Object::GenerateMassOrderLabelsRequest->new(); # GenerateMassOrderLabelsRequest | 
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

eval {
    my $result = $api_instance->generateMassOrderLabelsReport(generateMassOrderLabelsRequest => $generateMassOrderLabelsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateMassOrderLabelsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateMassOrderLabelsRequest =  # GenerateMassOrderLabelsRequest | 
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в нескольких заказах
    api_response = api_instance.generate_mass_order_labels_report(generateMassOrderLabelsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateMassOrderLabelsReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest
    let format = ; // PageFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateMassOrderLabelsRequest *

Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Responses


generateOrderLabel

Готовый ярлык‑наклейка для коробки в заказе

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Идентификатор грузоместа.
final Long boxId = new Long(); // Long | Идентификатор коробки.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabel: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Идентификатор грузоместа. (default to null)
Long *boxId = 789; // Идентификатор коробки. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовый ярлык‑наклейка для коробки в заказе
[apiInstance generateOrderLabelWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    boxId:boxId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Идентификатор грузоместа.
var boxId = 789; // {Long} Идентификатор коробки.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabel(campaignId, orderId, shipmentId, boxId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Идентификатор грузоместа. (default to null)
            var boxId = 789;  // Long | Идентификатор коробки. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовый ярлык‑наклейка для коробки в заказе
                File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateOrderLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Идентификатор грузоместа.
$boxId = 789; // Long | Идентификатор коробки.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabel($campaignId, $orderId, $shipmentId, $boxId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateOrderLabel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Идентификатор грузоместа.
my $boxId = 789; # Long | Идентификатор коробки.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabel(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, boxId => $boxId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateOrderLabel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Идентификатор грузоместа. (default to null)
boxId = 789 # Long | Идентификатор коробки. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовый ярлык‑наклейка для коробки в заказе
    api_response = api_instance.generate_order_label(campaignId, orderId, shipmentId, boxId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateOrderLabel: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let boxId = 789; // Long
    let format = ; // PageFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Идентификатор грузоместа.
Required
boxId*
Long (int64)
Идентификатор коробки.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generateOrderLabels

Готовые ярлыки‑наклейки на все коробки в одном заказе

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabels(campaignId, orderId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabels: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в одном заказе
[apiInstance generateOrderLabelsWith:campaignId
    orderId:orderId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabels(campaignId, orderId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в одном заказе
                File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateOrderLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabels($campaignId, $orderId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateOrderLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabels(campaignId => $campaignId, orderId => $orderId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateOrderLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в одном заказе
    api_response = api_instance.generate_order_labels(campaignId, orderId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateOrderLabels: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let format = ; // PageFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateOrderLabels(campaignId, orderId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generatePricesReport

Отчет «Цены на рынке»

Запускает генерацию **отчета «Цены на рынке»**. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/prices/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/prices/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "creationDateTo" : "2000-01-23",
  "campaignId" : 6,
  "businessId" : 0,
  "creationDateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GeneratePricesReportRequest generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generatePricesReport(generatePricesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generatePricesReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GeneratePricesReportRequest *generatePricesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Цены на рынке»
[apiInstance generatePricesReportWith:generatePricesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generatePricesReportRequest = ; // {GeneratePricesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generatePricesReport(generatePricesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generatePricesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Цены на рынке»
                GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generatePricesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generatePricesReportRequest = ; // GeneratePricesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generatePricesReport($generatePricesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generatePricesReportRequest = WWW::OPenAPIClient::Object::GeneratePricesReportRequest->new(); # GeneratePricesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generatePricesReport(generatePricesReportRequest => $generatePricesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generatePricesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generatePricesReportRequest =  # GeneratePricesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Цены на рынке»
    api_response = api_instance.generate_prices_report(generatePricesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generatePricesReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generatePricesReportRequest = ; // GeneratePricesReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generatePricesReport(generatePricesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generatePricesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShelfsStatisticsReport

Отчет по полкам

Запускает генерацию **сводного отчета по полкам** — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf). Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/shelf-statistics/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shelf-statistics/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "attributionType" : "CLICKS"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShelfsStatisticsReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateShelfsStatisticsRequest *generateShelfsStatisticsRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по полкам
[apiInstance generateShelfsStatisticsReportWith:generateShelfsStatisticsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateShelfsStatisticsRequest = ; // {GenerateShelfsStatisticsRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShelfsStatisticsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по полкам
                GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateShelfsStatisticsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShelfsStatisticsReport($generateShelfsStatisticsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateShelfsStatisticsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateShelfsStatisticsRequest = WWW::OPenAPIClient::Object::GenerateShelfsStatisticsRequest->new(); # GenerateShelfsStatisticsRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShelfsStatisticsReport(generateShelfsStatisticsRequest => $generateShelfsStatisticsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateShelfsStatisticsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateShelfsStatisticsRequest =  # GenerateShelfsStatisticsRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по полкам
    api_response = api_instance.generate_shelfs_statistics_report(generateShelfsStatisticsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateShelfsStatisticsReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShelfsStatisticsRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShowsSalesReport

Отчет «Аналитика продаж»

Запускает генерацию **отчета «Аналитика продаж»** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/shows-sales.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/shows-sales/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=" \
 -d '{
  "campaignId" : 6,
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "grouping" : "CATEGORIES"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShowsSalesReportRequest generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShowsSalesReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateShowsSalesReportRequest *generateShowsSalesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Аналитика продаж»
[apiInstance generateShowsSalesReportWith:generateShowsSalesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateShowsSalesReportRequest = ; // {GenerateShowsSalesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShowsSalesReport(generateShowsSalesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShowsSalesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Аналитика продаж»
                GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateShowsSalesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShowsSalesReport($generateShowsSalesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateShowsSalesReportRequest = WWW::OPenAPIClient::Object::GenerateShowsSalesReportRequest->new(); # GenerateShowsSalesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShowsSalesReport(generateShowsSalesReportRequest => $generateShowsSalesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateShowsSalesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateShowsSalesReportRequest =  # GenerateShowsSalesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Аналитика продаж»
    api_response = api_instance.generate_shows_sales_report(generateShowsSalesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateShowsSalesReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateShowsSalesReport(generateShowsSalesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShowsSalesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateStocksOnWarehousesReport

Отчет по остаткам на складах

Запускает генерацию **отчета по остаткам на складах**. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. * Для остальных моделей — об остатках на соответствующем складе магазина. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/stocks-on-warehouses/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "hasStocks" : true,
  "reportDate" : "2000-01-23",
  "campaignId" : 0,
  "warehouseIds" : [ 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateStocksOnWarehousesReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateStocksOnWarehousesReportRequest *generateStocksOnWarehousesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по остаткам на складах
[apiInstance generateStocksOnWarehousesReportWith:generateStocksOnWarehousesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateStocksOnWarehousesReportRequest = ; // {GenerateStocksOnWarehousesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateStocksOnWarehousesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по остаткам на складах
                GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateStocksOnWarehousesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateStocksOnWarehousesReport($generateStocksOnWarehousesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateStocksOnWarehousesReportRequest = WWW::OPenAPIClient::Object::GenerateStocksOnWarehousesReportRequest->new(); # GenerateStocksOnWarehousesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest => $generateStocksOnWarehousesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateStocksOnWarehousesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateStocksOnWarehousesReportRequest =  # GenerateStocksOnWarehousesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по остаткам на складах
    api_response = api_instance.generate_stocks_on_warehouses_report(generateStocksOnWarehousesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateStocksOnWarehousesReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateStocksOnWarehousesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedMarketplaceServicesReport

Отчет по стоимости услуг

Запускает генерацию **отчета по стоимости услуг** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports.html) Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-----------------------------|---------------------------------| |По дате начисления услуги |`dateFrom` и `dateTo` | |По дате формирования акта |`year` и `month` | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-marketplace-services/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-marketplace-services/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "yearFrom" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "monthFrom" : 2,
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 2, 2 ],
  "dateFrom" : "2000-01-23",
  "monthTo" : 7,
  "yearTo" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedMarketplaceServicesReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateUnitedMarketplaceServicesReportRequest *generateUnitedMarketplaceServicesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по стоимости услуг
[apiInstance generateUnitedMarketplaceServicesReportWith:generateUnitedMarketplaceServicesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateUnitedMarketplaceServicesReportRequest = ; // {GenerateUnitedMarketplaceServicesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedMarketplaceServicesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по стоимости услуг
                GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateUnitedMarketplaceServicesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedMarketplaceServicesReport($generateUnitedMarketplaceServicesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateUnitedMarketplaceServicesReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedMarketplaceServicesReportRequest->new(); # GenerateUnitedMarketplaceServicesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest => $generateUnitedMarketplaceServicesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateUnitedMarketplaceServicesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateUnitedMarketplaceServicesReportRequest =  # GenerateUnitedMarketplaceServicesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по стоимости услуг
    api_response = api_instance.generate_united_marketplace_services_report(generateUnitedMarketplaceServicesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateUnitedMarketplaceServicesReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedMarketplaceServicesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedNettingReport

Отчет по платежам

Запускает генерацию **отчета по платежам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/transactions.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-------------------------|---------------------------------------| |О платежах за период |`dateFrom` и `dateTo` | |О платежном поручении |`bankOrderId` и `bankOrderDateTime` | Заказать отчеты обоих типов одним запросом нельзя. |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-netting/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-netting/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "bankOrderId" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 1, 1 ],
  "dateFrom" : "2000-01-23",
  "bankOrderDateTime" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedNettingReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateUnitedNettingReportRequest *generateUnitedNettingReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по платежам
[apiInstance generateUnitedNettingReportWith:generateUnitedNettingReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateUnitedNettingReportRequest = ; // {GenerateUnitedNettingReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedNettingReport(generateUnitedNettingReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedNettingReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по платежам
                GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateUnitedNettingReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedNettingReport($generateUnitedNettingReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateUnitedNettingReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedNettingReportRequest->new(); # GenerateUnitedNettingReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedNettingReport(generateUnitedNettingReportRequest => $generateUnitedNettingReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateUnitedNettingReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateUnitedNettingReportRequest =  # GenerateUnitedNettingReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по платежам
    api_response = api_instance.generate_united_netting_report(generateUnitedNettingReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateUnitedNettingReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateUnitedNettingReport(generateUnitedNettingReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedNettingReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedOrdersReport

Отчет по заказам

Запускает генерацию **отчета по заказам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/orders.html) {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. [Как получить детальную информацию по заказам](../../reference/stats/getOrdersStats.md) {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-orders/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-orders/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 6, 6 ],
  "promoId" : "promoId",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedOrdersRequest generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedOrdersReport: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GenerateUnitedOrdersRequest *generateUnitedOrdersRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по заказам
[apiInstance generateUnitedOrdersReportWith:generateUnitedOrdersRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var generateUnitedOrdersRequest = ; // {GenerateUnitedOrdersRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedOrdersReport(generateUnitedOrdersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedOrdersReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по заказам
                GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.generateUnitedOrdersReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedOrdersReport($generateUnitedOrdersRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $generateUnitedOrdersRequest = WWW::OPenAPIClient::Object::GenerateUnitedOrdersRequest->new(); # GenerateUnitedOrdersRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedOrdersReport(generateUnitedOrdersRequest => $generateUnitedOrdersRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->generateUnitedOrdersReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
generateUnitedOrdersRequest =  # GenerateUnitedOrdersRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по заказам
    api_response = api_instance.generate_united_orders_report(generateUnitedOrdersRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->generateUnitedOrdersReport: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest
    let format = ; // ReportFormatType

    let mut context = DbsApi::Context::default();
    let result = client.generateUnitedOrdersReport(generateUnitedOrdersRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedOrdersRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


getAllOffers

Все предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers/all

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/all?feedId=789&chunk=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer chunk = new Integer(); // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    final result = await api_instance.getAllOffers(campaignId, feedId, chunk);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
Integer *chunk = 56; // Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

// Все предложения магазина
[apiInstance getAllOffersWith:campaignId
    feedId:feedId
    chunk:chunk
              completionHandler: ^(GetAllOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'chunk': 56 // {Integer} Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getAllOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var chunk = 56;  // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional)  (default to null)

            try {
                // Все предложения магазина
                GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getAllOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    $result = $api_instance->getAllOffers($campaignId, $feedId, $chunk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getAllOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $chunk = 56; # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


eval {
    my $result = $api_instance->getAllOffers(campaignId => $campaignId, feedId => $feedId, chunk => $chunk);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getAllOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
chunk = 56 # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

try:
    # Все предложения магазина
    api_response = api_instance.get_all_offers(campaignId, feedId=feedId, chunk=chunk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getAllOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let chunk = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getAllOffers(campaignId, feedId, chunk, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
feedId
Long (int64)
Идентификатор прайс-листа.
chunk
Integer (int32)
Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}

Responses


getBidsInfoForBusiness

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/info

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | 

try {
    final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; //  (optional)

// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
    pageToken:pageToken
    limit:limit
    getBidsInfoRequest:getBidsInfoRequest
              completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getBidsInfoRequest':  // {GetBidsInfoRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsInfoForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |  (optional) 

            try {
                // Информация об установленных ставках
                GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getBidsInfoForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getBidsInfoRequest = ; // GetBidsInfoRequest | 

try {
    $result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest | 

eval {
    my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getBidsInfoRequest =  # GetBidsInfoRequest |  (optional)

try:
    # Информация об установленных ставках
    api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getBidsInfoForBusiness: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getBidsInfoRequest = ; // GetBidsInfoRequest

    let mut context = DbsApi::Context::default();
    let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsInfoRequest

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBidsRecommendations

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetBidsRecommendationsRequest getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

try {
    final result = await api_instance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsRecommendations: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetBidsRecommendationsRequest *getBidsRecommendationsRequest = ; // 

// Рекомендованные ставки для заданных товаров
[apiInstance getBidsRecommendationsWith:businessId
    getBidsRecommendationsRequest:getBidsRecommendationsRequest
              completionHandler: ^(GetBidsRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getBidsRecommendationsRequest = ; // {GetBidsRecommendationsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsRecommendations(businessId, getBidsRecommendationsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

            try {
                // Рекомендованные ставки для заданных товаров
                GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getBidsRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

try {
    $result = $api_instance->getBidsRecommendations($businessId, $getBidsRecommendationsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getBidsRecommendationsRequest = WWW::OPenAPIClient::Object::GetBidsRecommendationsRequest->new(); # GetBidsRecommendationsRequest | 

eval {
    my $result = $api_instance->getBidsRecommendations(businessId => $businessId, getBidsRecommendationsRequest => $getBidsRecommendationsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getBidsRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getBidsRecommendationsRequest =  # GetBidsRecommendationsRequest | 

try:
    # Рекомендованные ставки для заданных товаров
    api_response = api_instance.get_bids_recommendations(businessId, getBidsRecommendationsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getBidsRecommendations: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getBidsRecommendations(businessId, getBidsRecommendationsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsRecommendationsRequest *

description.

Responses


getBusinessQuarantineOffers

Список товаров, находящихся в карантине по цене в кабинете

Возвращает список товаров, которые находятся в карантине по **основной цене**. Основная цена задается в каталоге и действует во всех магазинах кабинета. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST businesses/{businessId}/price-quarantine/confirm](../../reference/business-assortment/confirmBusinessPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessQuarantineOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в кабинете
[apiInstance getBusinessQuarantineOffersWith:businessId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в кабинете
                GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getBusinessQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getBusinessQuarantineOffers($businessId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getBusinessQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getBusinessQuarantineOffers(businessId => $businessId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getBusinessQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в кабинете
    api_response = api_instance.get_business_quarantine_offers(businessId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getBusinessQuarantineOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBusinessSettings

Настройки кабинета

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/settings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getBusinessSettings(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessSettings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки кабинета
[apiInstance getBusinessSettingsWith:businessId
              completionHandler: ^(GetBusinessSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessSettings(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки кабинета
                GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getBusinessSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getBusinessSettings($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getBusinessSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getBusinessSettings(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getBusinessSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки кабинета
    api_response = api_instance.get_business_settings(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getBusinessSettings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getBusinessSettings(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaign

Информация о магазине

Возвращает информацию о магазине. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaign(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaign: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Информация о магазине
[apiInstance getCampaignWith:campaignId
              completionHandler: ^(GetCampaignResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Информация о магазине
                GetCampaignResponse result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Информация о магазине
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaign: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignLogins

Логины, связанные с магазином

Возвращает список логинов, у которых есть доступ к магазину. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/logins

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/logins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignLogins(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignLogins: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Логины, связанные с магазином
[apiInstance getCampaignLoginsWith:campaignId
              completionHandler: ^(GetCampaignLoginsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignLogins(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignLoginsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Логины, связанные с магазином
                GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignLogins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignLogins($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignLogins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignLogins(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignLogins: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Логины, связанные с магазином
    api_response = api_instance.get_campaign_logins(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignLogins: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignLogins(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignOffers

Информация о товарах, которые размещены в заданном магазине

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "statuses" : [ "PUBLISHED", "PUBLISHED" ],
  "offerIds" : [ null, null, null, null, null ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetCampaignOffersRequest getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetCampaignOffersRequest *getCampaignOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Информация о товарах, которые размещены в заданном магазине
[apiInstance getCampaignOffersWith:campaignId
    getCampaignOffersRequest:getCampaignOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getCampaignOffersRequest = ; // {GetCampaignOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignOffers(campaignId, getCampaignOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Информация о товарах, которые размещены в заданном магазине
                GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignOffers($campaignId, $getCampaignOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getCampaignOffersRequest = WWW::OPenAPIClient::Object::GetCampaignOffersRequest->new(); # GetCampaignOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignOffers(campaignId => $campaignId, getCampaignOffersRequest => $getCampaignOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getCampaignOffersRequest =  # GetCampaignOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Информация о товарах, которые размещены в заданном магазине
    api_response = api_instance.get_campaign_offers(campaignId, getCampaignOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getCampaignOffersRequest = ; // GetCampaignOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getCampaignOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignQuarantineOffers

Список товаров, находящихся в карантине по цене в магазине

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST campaigns/{campaignId}/price-quarantine/confirm](../../reference/assortment/confirmCampaignPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignQuarantineOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в магазине
[apiInstance getCampaignQuarantineOffersWith:campaignId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в магазине
                GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignQuarantineOffers($campaignId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignQuarantineOffers(campaignId => $campaignId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в магазине
    api_response = api_instance.get_campaign_quarantine_offers(campaignId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignQuarantineOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignRegion

Регион магазина

{% note warning "" %} Этот метод устарел. Вместо него используйте [GET campaigns/{campaignId}/settings](../../reference/campaigns/getCampaignSettings.md). {% endnote %} Возвращает регион, в котором находится магазин. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/campaigns/{campaignId}/region

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignRegion(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignRegion: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Регион магазина
[apiInstance getCampaignRegionWith:campaignId
              completionHandler: ^(GetCampaignRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignRegion(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignRegionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Регион магазина
                GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignRegion($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignRegion(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Регион магазина
    api_response = api_instance.get_campaign_region(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignRegion: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignRegion(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignSettings

Настройки магазина

Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/settings

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignSettings(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignSettings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки магазина
[apiInstance getCampaignSettingsWith:campaignId
              completionHandler: ^(GetCampaignSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignSettings(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки магазина
                GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignSettings($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignSettings(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки магазина
    api_response = api_instance.get_campaign_settings(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignSettings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignSettings(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaigns

Список магазинов пользователя

Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaigns(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaigns: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Список магазинов пользователя
[apiInstance getCampaignsWith:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaigns(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Список магазинов пользователя
                GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaigns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaigns($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaigns(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Список магазинов пользователя
    api_response = api_instance.get_campaigns(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaigns: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getCampaigns(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCampaignsByLogin

Магазины, доступные логину

Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/by_login/{login}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/by_login/{login}?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String login = new String(); // String | Логин пользователя.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaignsByLogin(login, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignsByLogin: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
String *login = login_example; // Логин пользователя. (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Магазины, доступные логину
[apiInstance getCampaignsByLoginWith:login
    page:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var login = login_example; // {String} Логин пользователя.
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignsByLogin(login, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsByLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var login = login_example;  // String | Логин пользователя. (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Магазины, доступные логину
                GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCampaignsByLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$login = login_example; // String | Логин пользователя.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaignsByLogin($login, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCampaignsByLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $login = login_example; # String | Логин пользователя.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaignsByLogin(login => $login, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCampaignsByLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
login = login_example # String | Логин пользователя. (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Магазины, доступные логину
    api_response = api_instance.get_campaigns_by_login(login, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCampaignsByLogin: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let login = login_example; // String
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getCampaignsByLogin(login, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
login*
String
Логин пользователя.
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCategoriesMaxSaleQuantum

Лимит на установку кванта продажи и минимального количества товаров в заказе

Возвращает лимит на установку [кванта](*quantum) и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий. Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины. Подробнее о том, как продавать товары по несколько штук, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/fields/quantum). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/max-sale-quantum

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/max-sale-quantum" \
 -d '{
  "marketCategoryIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

try {
    final result = await api_instance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesMaxSaleQuantum: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GetCategoriesMaxSaleQuantumRequest *getCategoriesMaxSaleQuantumRequest = ; // 

// Лимит на установку кванта продажи и минимального количества товаров в заказе
[apiInstance getCategoriesMaxSaleQuantumWith:getCategoriesMaxSaleQuantumRequest
              completionHandler: ^(GetCategoriesMaxSaleQuantumResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var getCategoriesMaxSaleQuantumRequest = ; // {GetCategoriesMaxSaleQuantumRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesMaxSaleQuantumExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

            try {
                // Лимит на установку кванта продажи и минимального количества товаров в заказе
                GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCategoriesMaxSaleQuantum: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

try {
    $result = $api_instance->getCategoriesMaxSaleQuantum($getCategoriesMaxSaleQuantumRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCategoriesMaxSaleQuantum: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $getCategoriesMaxSaleQuantumRequest = WWW::OPenAPIClient::Object::GetCategoriesMaxSaleQuantumRequest->new(); # GetCategoriesMaxSaleQuantumRequest | 

eval {
    my $result = $api_instance->getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest => $getCategoriesMaxSaleQuantumRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCategoriesMaxSaleQuantum: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
getCategoriesMaxSaleQuantumRequest =  # GetCategoriesMaxSaleQuantumRequest | 

try:
    # Лимит на установку кванта продажи и минимального количества товаров в заказе
    api_response = api_instance.get_categories_max_sale_quantum(getCategoriesMaxSaleQuantumRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCategoriesMaxSaleQuantum: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest

    let mut context = DbsApi::Context::default();
    let result = client.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesMaxSaleQuantumRequest *

Responses


getCategoriesTree

Дерево категорий

Возвращает дерево категорий Маркета. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/tree

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/tree" \
 -d '{
  "language" : "RU"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesRequest getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest | 

try {
    final result = await api_instance.getCategoriesTree(getCategoriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesTree: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
GetCategoriesRequest *getCategoriesRequest = ; //  (optional)

// Дерево категорий
[apiInstance getCategoriesTreeWith:getCategoriesRequest
              completionHandler: ^(GetCategoriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var opts = {
  'getCategoriesRequest':  // {GetCategoriesRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesTree(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesTreeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest |  (optional) 

            try {
                // Дерево категорий
                GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCategoriesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$getCategoriesRequest = ; // GetCategoriesRequest | 

try {
    $result = $api_instance->getCategoriesTree($getCategoriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCategoriesTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $getCategoriesRequest = WWW::OPenAPIClient::Object::GetCategoriesRequest->new(); # GetCategoriesRequest | 

eval {
    my $result = $api_instance->getCategoriesTree(getCategoriesRequest => $getCategoriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCategoriesTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
getCategoriesRequest =  # GetCategoriesRequest |  (optional)

try:
    # Дерево категорий
    api_response = api_instance.get_categories_tree(getCategoriesRequest=getCategoriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCategoriesTree: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let getCategoriesRequest = ; // GetCategoriesRequest

    let mut context = DbsApi::Context::default();
    let result = client.getCategoriesTree(getCategoriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesRequest

Responses


getCategoryContentParameters

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |**⚙️ Лимит:** 50 категорий в минуту | |-|


/category/{categoryId}/parameters

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/category/{categoryId}/parameters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long categoryId = new Long(); // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    final result = await api_instance.getCategoryContentParameters(categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryContentParameters: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *categoryId = 789; // Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

// Списки характеристик товаров по категориям
[apiInstance getCategoryContentParametersWith:categoryId
              completionHandler: ^(GetCategoryContentParametersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var categoryId = 789; // {Long} Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryContentParameters(categoryId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoryContentParametersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var categoryId = 789;  // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

            try {
                // Списки характеристик товаров по категориям
                GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getCategoryContentParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    $result = $api_instance->getCategoryContentParameters($categoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getCategoryContentParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $categoryId = 789; # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


eval {
    my $result = $api_instance->getCategoryContentParameters(categoryId => $categoryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getCategoryContentParameters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
categoryId = 789 # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

try:
    # Списки характеристик товаров по категориям
    api_response = api_instance.get_category_content_parameters(categoryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getCategoryContentParameters: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let categoryId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getCategoryContentParameters(categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
categoryId*
Long (int64)
Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
Required

Responses


getChatHistory

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history?chatId=789&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "messageIdFrom" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final GetChatHistoryRequest getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChatHistory: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
GetChatHistoryRequest *getChatHistoryRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение истории сообщений в чате
[apiInstance getChatHistoryWith:businessId
    chatId:chatId
    getChatHistoryRequest:getChatHistoryRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatHistoryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var getChatHistoryRequest = ; // {GetChatHistoryRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatHistory(businessId, chatId, getChatHistoryRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatHistoryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение истории сообщений в чате
                GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getChatHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$getChatHistoryRequest = ; // GetChatHistoryRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChatHistory($businessId, $chatId, $getChatHistoryRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $getChatHistoryRequest = WWW::OPenAPIClient::Object::GetChatHistoryRequest->new(); # GetChatHistoryRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChatHistory(businessId => $businessId, chatId => $chatId, getChatHistoryRequest => $getChatHistoryRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getChatHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
getChatHistoryRequest =  # GetChatHistoryRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение истории сообщений в чате
    api_response = api_instance.get_chat_history(businessId, chatId, getChatHistoryRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getChatHistory: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let getChatHistoryRequest = ; // GetChatHistoryRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatHistoryRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getChats

Получение доступных чатов

Возвращает ваши чаты с покупателями. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "types" : [ "CHAT", "CHAT" ],
  "statuses" : [ "NEW", "NEW" ],
  "orderIds" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getChats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetChatsRequest getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChats(businessId, getChatsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChats: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getChats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetChatsRequest *getChatsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение доступных чатов
[apiInstance getChatsWith:businessId
    getChatsRequest:getChatsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getChatsRequest = ; // {GetChatsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChats(businessId, getChatsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение доступных чатов
                GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getChatsRequest = ; // GetChatsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChats($businessId, $getChatsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getChatsRequest = WWW::OPenAPIClient::Object::GetChatsRequest->new(); # GetChatsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChats(businessId => $businessId, getChatsRequest => $getChatsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getChatsRequest =  # GetChatsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение доступных чатов
    api_response = api_instance.get_chats(businessId, getChatsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getChats: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getChatsRequest = ; // GetChatsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getChats(businessId, getChatsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatsRequest *

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getDeliveryServices

Справочник служб доставки

Возвращает справочник служб доставки: идентификаторы и наименования. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/delivery/services

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/delivery/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDeliveryServices();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDeliveryServices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];

// Справочник служб доставки
[apiInstance getDeliveryServicesWithCompletionHandler: 
              ^(GetDeliveryServicesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryServices(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getDeliveryServicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();

            try {
                // Справочник служб доставки
                GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getDeliveryServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();

try {
    $result = $api_instance->getDeliveryServices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getDeliveryServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();

eval {
    my $result = $api_instance->getDeliveryServices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getDeliveryServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()

try:
    # Справочник служб доставки
    api_response = api_instance.get_delivery_services()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getDeliveryServices: %s\n" % e)
extern crate DbsApi;

pub fn main() {

    let mut context = DbsApi::Context::default();
    let result = client.getDeliveryServices(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


getFeed

Информация о прайс-листе

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.getFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeed: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Информация о прайс-листе
[apiInstance getFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(GetFeedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Информация о прайс-листе
                GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->getFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->getFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Информация о прайс-листе
    api_response = api_instance.get_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getFeed: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


getFeedIndexLogs

Отчет по индексации прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра `generationId`. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}/index-logs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs?limit=20&published_time_from=2013-10-20T19:20:30+01:00&published_time_to=2013-10-20T19:20:30+01:00&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Date publishedTimeFrom = new Date(); // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

final Date publishedTimeTo = new Date(); // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

final FeedIndexLogsStatusType status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    final result = await api_instance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedIndexLogs: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Date *publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
Date *publishedTimeTo = 2013-10-20T19:20:30+01:00; // Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
FeedIndexLogsStatusType *status = ; // Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

// Отчет по индексации прайс-листа
[apiInstance getFeedIndexLogsWith:campaignId
    feedId:feedId
    limit:limit
    publishedTimeFrom:publishedTimeFrom
    publishedTimeTo:publishedTimeTo
    status:status
              completionHandler: ^(GetFeedIndexLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var opts = {
  'limit': 20, // {Integer} Количество значений на одной странице.

  'publishedTimeFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

  'publishedTimeTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

  'status':  // {FeedIndexLogsStatusType} Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedIndexLogs(campaignId, feedId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedIndexLogsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var publishedTimeFrom = 2013-10-20T19:20:30+01:00;  // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional)  (default to null)
            var publishedTimeTo = 2013-10-20T19:20:30+01:00;  // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional)  (default to null)
            var status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional)  (default to null)

            try {
                // Отчет по индексации прайс-листа
                GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getFeedIndexLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$limit = 20; // Integer | Количество значений на одной странице.

$publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

$publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

$status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    $result = $api_instance->getFeedIndexLogs($campaignId, $feedId, $limit, $publishedTimeFrom, $publishedTimeTo, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $limit = 20; # Integer | Количество значений на одной странице.

my $publishedTimeFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

my $publishedTimeTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

my $status = ; # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


eval {
    my $result = $api_instance->getFeedIndexLogs(campaignId => $campaignId, feedId => $feedId, limit => $limit, publishedTimeFrom => $publishedTimeFrom, publishedTimeTo => $publishedTimeTo, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getFeedIndexLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
publishedTimeFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
publishedTimeTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
status =  # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

try:
    # Отчет по индексации прайс-листа
    api_response = api_instance.get_feed_index_logs(campaignId, feedId, limit=limit, publishedTimeFrom=publishedTimeFrom, publishedTimeTo=publishedTimeTo, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getFeedIndexLogs: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let limit = 20; // Integer
    let publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date
    let publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date
    let status = ; // FeedIndexLogsStatusType

    let mut context = DbsApi::Context::default();
    let result = client.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Query parameters
Name Description
limit
Integer (int32)
Количество значений на одной странице.
published_time_from
Date (date-time)
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.
published_time_to
Date (date-time)
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}
status
FeedIndexLogsStatusType
Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

Responses


getFeedbackAndCommentUpdates

Новые и обновленные отзывы о магазине

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает новые и обновленные отзывы о магазине на Маркете. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/feedback/updates

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feedback/updates?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&from_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final date fromDate = new date(); // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    final result = await api_instance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedbackAndCommentUpdates: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
date *fromDate = 2013-10-20; // Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

// Новые и обновленные отзывы о магазине
[apiInstance getFeedbackAndCommentUpdatesWith:campaignId
    pageToken:pageToken
    limit:limit
    fromDate:fromDate
              completionHandler: ^(GetFeedbackListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'fromDate': 2013-10-20 // {date} Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedbackAndCommentUpdates(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedbackAndCommentUpdatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var fromDate = 2013-10-20;  // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)

            try {
                // Новые и обновленные отзывы о магазине
                GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getFeedbackAndCommentUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    $result = $api_instance->getFeedbackAndCommentUpdates($campaignId, $pageToken, $limit, $fromDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getFeedbackAndCommentUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $fromDate = 2013-10-20; # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


eval {
    my $result = $api_instance->getFeedbackAndCommentUpdates(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, fromDate => $fromDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getFeedbackAndCommentUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
fromDate = 2013-10-20 # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

try:
    # Новые и обновленные отзывы о магазине
    api_response = api_instance.get_feedback_and_comment_updates(campaignId, pageToken=pageToken, limit=limit, fromDate=fromDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getFeedbackAndCommentUpdates: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let fromDate = 2013-10-20; // date

    let mut context = DbsApi::Context::default();
    let result = client.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
from_date
date (date)
Начальная дата обновления отзывов. Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты. Формат даты: `ГГГГ-ММ-ДД`.

Responses


getFeeds

Список прайс-листов магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getFeeds(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeeds: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список прайс-листов магазина
[apiInstance getFeedsWith:campaignId
              completionHandler: ^(GetFeedsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список прайс-листов магазина
                GetFeedsResponse result = apiInstance.getFeeds(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getFeeds($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getFeeds(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getFeeds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список прайс-листов магазина
    api_response = api_instance.get_feeds(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getFeeds: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getFeeds(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getGoodsFeedbackComments

Получение комментариев к отзыву

Возвращает комментарии к отзыву. Результаты возвращаются постранично, одна страница содержит не более 20 комментариев. Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "feedbackId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbackComments: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsFeedbackCommentsRequest *getGoodsFeedbackCommentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение комментариев к отзыву
[apiInstance getGoodsFeedbackCommentsWith:businessId
    getGoodsFeedbackCommentsRequest:getGoodsFeedbackCommentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetGoodsFeedbackCommentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsFeedbackCommentsRequest = ; // {GetGoodsFeedbackCommentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbackCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение комментариев к отзыву
                GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getGoodsFeedbackComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getGoodsFeedbackComments($businessId, $getGoodsFeedbackCommentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getGoodsFeedbackComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsFeedbackCommentsRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackCommentsRequest->new(); # GetGoodsFeedbackCommentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getGoodsFeedbackComments(businessId => $businessId, getGoodsFeedbackCommentsRequest => $getGoodsFeedbackCommentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getGoodsFeedbackComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsFeedbackCommentsRequest =  # GetGoodsFeedbackCommentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение комментариев к отзыву
    api_response = api_instance.get_goods_feedback_comments(businessId, getGoodsFeedbackCommentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getGoodsFeedbackComments: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackCommentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsFeedbacks

Получение отзывов о товарах продавца

Возвращает все отзывы о товарах продавца по указанным фильтрам. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "ratingValues" : [ 0, 0, 0, 0, 0 ],
  "modelIds" : [ 6, 6, 6, 6, 6 ],
  "paid" : true,
  "reactionStatus" : "ALL",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetGoodsFeedbackRequest getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest | 

try {
    final result = await api_instance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbacks: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetGoodsFeedbackRequest *getGoodsFeedbackRequest = ; //  (optional)

// Получение отзывов о товарах продавца
[apiInstance getGoodsFeedbacksWith:businessId
    pageToken:pageToken
    limit:limit
    getGoodsFeedbackRequest:getGoodsFeedbackRequest
              completionHandler: ^(GetGoodsFeedbackResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getGoodsFeedbackRequest':  // {GetGoodsFeedbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbacks(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest |  (optional) 

            try {
                // Получение отзывов о товарах продавца
                GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getGoodsFeedbacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

try {
    $result = $api_instance->getGoodsFeedbacks($businessId, $pageToken, $limit, $getGoodsFeedbackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getGoodsFeedbacks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackRequest->new(); # GetGoodsFeedbackRequest | 

eval {
    my $result = $api_instance->getGoodsFeedbacks(businessId => $businessId, pageToken => $pageToken, limit => $limit, getGoodsFeedbackRequest => $getGoodsFeedbackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getGoodsFeedbacks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getGoodsFeedbackRequest =  # GetGoodsFeedbackRequest |  (optional)

try:
    # Получение отзывов о товарах продавца
    api_response = api_instance.get_goods_feedbacks(businessId, pageToken=pageToken, limit=limit, getGoodsFeedbackRequest=getGoodsFeedbackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getGoodsFeedbacks: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest

    let mut context = DbsApi::Context::default();
    let result = client.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsStats

Отчет по товарам

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/stats/skus

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/skus" \
 -d '{
  "shopSkus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsStatsRequest getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

try {
    final result = await api_instance.getGoodsStats(campaignId, getGoodsStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsStats: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsStatsRequest *getGoodsStatsRequest = ; // 

// Отчет по товарам
[apiInstance getGoodsStatsWith:campaignId
    getGoodsStatsRequest:getGoodsStatsRequest
              completionHandler: ^(GetGoodsStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsStatsRequest = ; // {GetGoodsStatsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsStats(campaignId, getGoodsStatsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

            try {
                // Отчет по товарам
                GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getGoodsStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

try {
    $result = $api_instance->getGoodsStats($campaignId, $getGoodsStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getGoodsStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsStatsRequest = WWW::OPenAPIClient::Object::GetGoodsStatsRequest->new(); # GetGoodsStatsRequest | 

eval {
    my $result = $api_instance->getGoodsStats(campaignId => $campaignId, getGoodsStatsRequest => $getGoodsStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getGoodsStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsStatsRequest =  # GetGoodsStatsRequest | 

try:
    # Отчет по товарам
    api_response = api_instance.get_goods_stats(campaignId, getGoodsStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getGoodsStats: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getGoodsStatsRequest = ; // GetGoodsStatsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getGoodsStats(campaignId, getGoodsStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsStatsRequest *

Responses


getHiddenOffers

Информация о скрытых вами товарах

Возвращает список скрытых вами товаров для заданного магазина. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers?offer_id=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&offset=56&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Integer offset = new Integer(); // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHiddenOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор скрытого предложения.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Integer *offset = 56; // Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о скрытых вами товарах
[apiInstance getHiddenOffersWith:campaignId
    offerId:offerId
    pageToken:pageToken
    limit:limit
    offset:offset
    page:page
    pageSize:pageSize
              completionHandler: ^(GetHiddenOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор скрытого предложения.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'offset': 56, // {Integer} Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHiddenOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var offset = 56;  // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о скрытых вами товарах
                GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор скрытого предложения.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getHiddenOffers($campaignId, $offerId, $pageToken, $limit, $offset, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор скрытого предложения.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $offset = 56; # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getHiddenOffers(campaignId => $campaignId, offerId => $offerId, pageToken => $pageToken, limit => $limit, offset => $offset, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор скрытого предложения.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
offset = 56 # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о скрытых вами товарах
    api_response = api_instance.get_hidden_offers(campaignId, offerId=offerId, pageToken=pageToken, limit=limit, offset=offset, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getHiddenOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let offset = 56; // Integer
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор скрытого предложения.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
offset
Integer (int32)
Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getModel

Информация об одной модели

Возвращает информацию о модели товара. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/{modelId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models/{modelId}?regionId=789¤cy="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long modelId = new Long(); // Long | Идентификатор модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    final result = await api_instance.getModel(modelId, regionId, currency);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModel: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *modelId = 789; // Идентификатор модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

// Информация об одной модели
[apiInstance getModelWith:modelId
    regionId:regionId
    currency:currency
              completionHandler: ^(GetModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var modelId = 789; // {Long} Идентификатор модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency':  // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModel(modelId, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var modelId = 789;  // Long | Идентификатор модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)

            try {
                // Информация об одной модели
                GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$modelId = 789; // Long | Идентификатор модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    $result = $api_instance->getModel($modelId, $regionId, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $modelId = 789; # Long | Идентификатор модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


eval {
    my $result = $api_instance->getModel(modelId => $modelId, regionId => $regionId, currency => $currency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
modelId = 789 # Long | Идентификатор модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

try:
    # Информация об одной модели
    api_response = api_instance.get_model(modelId, regionId, currency=currency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getModel: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let modelId = 789; // Long
    let regionId = 789; // Long
    let currency = ; // CurrencyType

    let mut context = DbsApi::Context::default();
    let result = client.getModel(modelId, regionId, currency, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
modelId*
Long (int64)
Идентификатор модели товара.
Required
Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

Responses


getModelOffers

Список предложений для одной модели

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется. Для методов `GET models/{modelId}/offers` и `POST models/offers` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/{modelId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models/{modelId}/offers?regionId=789¤cy=&orderByPrice=&count=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

        Integer count = 56; // Integer | Количество предложений на странице ответа.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModelOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long modelId = new Long(); // Long | Идентификатор модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final SortOrderType orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

final Integer count = new Integer(); // Integer | Количество предложений на странице ответа.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModelOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

        Integer count = 56; // Integer | Количество предложений на странице ответа.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModelOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *modelId = 789; // Идентификатор модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
SortOrderType *orderByPrice = ; // Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)
Integer *count = 56; // Количество предложений на странице ответа. (optional) (default to 10)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)

// Список предложений для одной модели
[apiInstance getModelOffersWith:modelId
    regionId:regionId
    currency:currency
    orderByPrice:orderByPrice
    count:count
    page:page
              completionHandler: ^(GetModelsOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var modelId = 789; // {Long} Идентификатор модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'orderByPrice': , // {SortOrderType} Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

  'count': 56, // {Integer} Количество предложений на странице ответа.
  'page': 56 // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelOffers(modelId, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var modelId = 789;  // Long | Идентификатор модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional)  (default to null)
            var count = 56;  // Integer | Количество предложений на странице ответа. (optional)  (default to 10)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)

            try {
                // Список предложений для одной модели
                GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getModelOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$modelId = 789; // Long | Идентификатор модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

$count = 56; // Integer | Количество предложений на странице ответа.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getModelOffers($modelId, $regionId, $currency, $orderByPrice, $count, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getModelOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $modelId = 789; # Long | Идентификатор модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $orderByPrice = ; # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

my $count = 56; # Integer | Количество предложений на странице ответа.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getModelOffers(modelId => $modelId, regionId => $regionId, currency => $currency, orderByPrice => $orderByPrice, count => $count, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getModelOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
modelId = 789 # Long | Идентификатор модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
orderByPrice =  # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)
count = 56 # Integer | Количество предложений на странице ответа. (optional) (default to 10)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)

try:
    # Список предложений для одной модели
    api_response = api_instance.get_model_offers(modelId, regionId, currency=currency, orderByPrice=orderByPrice, count=count, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getModelOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let modelId = 789; // Long
    let regionId = 789; // Long
    let currency = ; // CurrencyType
    let orderByPrice = ; // SortOrderType
    let count = 56; // Integer
    let page = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getModelOffers(modelId, regionId, currency, orderByPrice, count, page, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
modelId*
Long (int64)
Идентификатор модели товара.
Required
Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
orderByPrice
SortOrderType
Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.
count
Integer (int32)
Количество предложений на странице ответа.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getModels

Информация о нескольких моделях

Возвращает информацию о моделях товаров. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/models?regionId=789¤cy=" \
 -d '{
  "models" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final GetModelsRequest getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    final result = await api_instance.getModels(regionId, getModelsRequest, currency);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModels: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
GetModelsRequest *getModelsRequest = ; // 
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

// Информация о нескольких моделях
[apiInstance getModelsWith:regionId
    getModelsRequest:getModelsRequest
    currency:currency
              completionHandler: ^(GetModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var getModelsRequest = ; // {GetModelsRequest} 
var opts = {
  'currency':  // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModels(regionId, getModelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)

            try {
                // Информация о нескольких моделях
                GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$getModelsRequest = ; // GetModelsRequest | 
$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    $result = $api_instance->getModels($regionId, $getModelsRequest, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $getModelsRequest = WWW::OPenAPIClient::Object::GetModelsRequest->new(); # GetModelsRequest | 
my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


eval {
    my $result = $api_instance->getModels(regionId => $regionId, getModelsRequest => $getModelsRequest, currency => $currency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getModels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
getModelsRequest =  # GetModelsRequest | 
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

try:
    # Информация о нескольких моделях
    api_response = api_instance.get_models(regionId, getModelsRequest, currency=currency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getModels: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let regionId = 789; // Long
    let getModelsRequest = ; // GetModelsRequest
    let currency = ; // CurrencyType

    let mut context = DbsApi::Context::default();
    let result = client.getModels(regionId, getModelsRequest, currency, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getModelsRequest *

Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

Responses


getModelsOffers

Список предложений для нескольких моделей

Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются. В одном запросе можно получить информацию о предложениях не более чем для 100 моделей. Для методов `GET models/{modelId}/offers` и `POST models/offers` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/models/offers?regionId=789¤cy=&orderByPrice=" \
 -d '{
  "models" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


        try {
            GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModelsOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final GetModelsRequest getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final SortOrderType orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


try {
    final result = await api_instance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModelsOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


        try {
            GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getModelsOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
GetModelsRequest *getModelsRequest = ; // 
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
SortOrderType *orderByPrice = ; // Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)

// Список предложений для нескольких моделей
[apiInstance getModelsOffersWith:regionId
    getModelsRequest:getModelsRequest
    currency:currency
    orderByPrice:orderByPrice
              completionHandler: ^(GetModelsOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var getModelsRequest = ; // {GetModelsRequest} 
var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'orderByPrice':  // {SortOrderType} Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelsOffers(regionId, getModelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelsOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional)  (default to null)

            try {
                // Список предложений для нескольких моделей
                GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getModelsOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$getModelsRequest = ; // GetModelsRequest | 
$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


try {
    $result = $api_instance->getModelsOffers($regionId, $getModelsRequest, $currency, $orderByPrice);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getModelsOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $getModelsRequest = WWW::OPenAPIClient::Object::GetModelsRequest->new(); # GetModelsRequest | 
my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $orderByPrice = ; # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


eval {
    my $result = $api_instance->getModelsOffers(regionId => $regionId, getModelsRequest => $getModelsRequest, currency => $currency, orderByPrice => $orderByPrice);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getModelsOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
getModelsRequest =  # GetModelsRequest | 
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
orderByPrice =  # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)

try:
    # Список предложений для нескольких моделей
    api_response = api_instance.get_models_offers(regionId, getModelsRequest, currency=currency, orderByPrice=orderByPrice)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getModelsOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let regionId = 789; // Long
    let getModelsRequest = ; // GetModelsRequest
    let currency = ; // CurrencyType
    let orderByPrice = ; // SortOrderType

    let mut context = DbsApi::Context::default();
    let result = client.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getModelsRequest *

Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
orderByPrice
SortOrderType
Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.

Responses


getOfferCardsContentStatus

Получение информации о заполненности карточек магазина

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * переданные характеристики товаров; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |**⚙️ Лимит:** 600 запросов в минуту| |-|


/businesses/{businessId}/offer-cards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ null, null, null, null, null ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest | 

try {
    final result = await api_instance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferCardsContentStatus: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferCardsContentStatusRequest *getOfferCardsContentStatusRequest = ; //  (optional)

// Получение информации о заполненности карточек магазина
[apiInstance getOfferCardsContentStatusWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferCardsContentStatusRequest:getOfferCardsContentStatusRequest
              completionHandler: ^(GetOfferCardsContentStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferCardsContentStatusRequest':  // {GetOfferCardsContentStatusRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferCardsContentStatus(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferCardsContentStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest |  (optional) 

            try {
                // Получение информации о заполненности карточек магазина
                GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOfferCardsContentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

try {
    $result = $api_instance->getOfferCardsContentStatus($businessId, $pageToken, $limit, $getOfferCardsContentStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOfferCardsContentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferCardsContentStatusRequest = WWW::OPenAPIClient::Object::GetOfferCardsContentStatusRequest->new(); # GetOfferCardsContentStatusRequest | 

eval {
    my $result = $api_instance->getOfferCardsContentStatus(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferCardsContentStatusRequest => $getOfferCardsContentStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOfferCardsContentStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferCardsContentStatusRequest =  # GetOfferCardsContentStatusRequest |  (optional)

try:
    # Получение информации о заполненности карточек магазина
    api_response = api_instance.get_offer_cards_content_status(businessId, pageToken=pageToken, limit=limit, getOfferCardsContentStatusRequest=getOfferCardsContentStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOfferCardsContentStatus: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest

    let mut context = DbsApi::Context::default();
    let result = client.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferCardsContentStatusRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappingEntries

Список товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров в каталоге магазина * 25)


/campaigns/{campaignId}/offer-mapping-entries

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries?offer_id=&shop_sku=&mapping_kind=&status=&availability=&category_id=&vendor=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор товара в каталоге.
final array[String] shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final OfferMappingKindType mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
final array[OfferProcessingStatusType] status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final array[OfferAvailabilityStatusType] availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[Integer] categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[String] vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор товара в каталоге. (optional) (default to null)
array[String] *shopSku = ; // Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
OfferMappingKindType *mappingKind = ; // Тип маппинга. (optional) (default to null)
array[OfferProcessingStatusType] *status = ; // Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[OfferAvailabilityStatusType] *availability = ; // Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[Integer] *categoryId = ; // Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[String] *vendor = ; // Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров в каталоге
[apiInstance getOfferMappingEntriesWith:campaignId
    offerId:offerId
    shopSku:shopSku
    mappingKind:mappingKind
    status:status
    availability:availability
    categoryId:categoryId
    vendor:vendor
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор товара в каталоге.
  'shopSku': , // {array[String]} Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'mappingKind': , // {OfferMappingKindType} Тип маппинга.
  'status': , // {array[OfferProcessingStatusType]} Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'availability': , // {array[OfferAvailabilityStatusType]} Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'categoryId': , // {array[Integer]} Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'vendor': , // {array[String]} Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappingEntries(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор товара в каталоге. (optional)  (default to null)
            var shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга. (optional)  (default to null)
            var status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров в каталоге
                GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор товара в каталоге.
$shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$mappingKind = ; // OfferMappingKindType | Тип маппинга.
$status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferMappingEntries($campaignId, $offerId, $shopSku, $mappingKind, $status, $availability, $categoryId, $vendor, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор товара в каталоге.
my $shopSku = []; # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $mappingKind = ; # OfferMappingKindType | Тип маппинга.
my $status = []; # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $availability = []; # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $categoryId = []; # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $vendor = []; # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferMappingEntries(campaignId => $campaignId, offerId => $offerId, shopSku => $shopSku, mappingKind => $mappingKind, status => $status, availability => $availability, categoryId => $categoryId, vendor => $vendor, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор товара в каталоге. (optional) (default to null)
shopSku =  # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
mappingKind =  # OfferMappingKindType | Тип маппинга. (optional) (default to null)
status =  # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
availability =  # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
categoryId =  # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
vendor =  # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров в каталоге
    api_response = api_instance.get_offer_mapping_entries(campaignId, offerId=offerId, shopSku=shopSku, mappingKind=mappingKind, status=status, availability=availability, categoryId=categoryId, vendor=vendor, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOfferMappingEntries: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let shopSku = ; // array[String]
    let mappingKind = ; // OfferMappingKindType
    let status = ; // array[OfferProcessingStatusType]
    let availability = ; // array[OfferAvailabilityStatusType]
    let categoryId = ; // array[Integer]
    let vendor = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор товара в каталоге.
shop_sku
array[String]
Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
mapping_kind
OfferMappingKindType
Тип маппинга.
status
array[OfferProcessingStatusType]
Фильтрация по статусу публикации товара: * `READY` — товар прошел модерацию. * `IN_WORK` — товар проходит модерацию. * `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * `OTHER` — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
availability
array[OfferAvailabilityStatusType]
Фильтрация по планам поставок товара: * `ACTIVE` — поставки будут. * `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
category_id
array[Integer]
Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md). Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
vendor
array[String]
Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL). В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappings

Информация о товарах в каталоге

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара. Можно использовать тремя способами: * задать список интересующих SKU; * задать фильтр — в этом случае результаты возвращаются постранично; * не передавать тело запроса, чтобы получить список всех товаров в каталоге. |**⚙️ Лимит:** 600 запросов в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferMappingsRequest getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest | 

try {
    final result = await api_instance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferMappingsRequest *getOfferMappingsRequest = ; //  (optional)

// Информация о товарах в каталоге
[apiInstance getOfferMappingsWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferMappingsRequest:getOfferMappingsRequest
              completionHandler: ^(GetOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferMappingsRequest':  // {GetOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest |  (optional) 

            try {
                // Информация о товарах в каталоге
                GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

try {
    $result = $api_instance->getOfferMappings($businessId, $pageToken, $limit, $getOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferMappingsRequest = WWW::OPenAPIClient::Object::GetOfferMappingsRequest->new(); # GetOfferMappingsRequest | 

eval {
    my $result = $api_instance->getOfferMappings(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferMappingsRequest => $getOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferMappingsRequest =  # GetOfferMappingsRequest |  (optional)

try:
    # Информация о товарах в каталоге
    api_response = api_instance.get_offer_mappings(businessId, pageToken=pageToken, limit=limit, getOfferMappingsRequest=getOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOfferMappings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferMappingsRequest = ; // GetOfferMappingsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferMappingsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferRecommendations

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. **1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.** Показывает, какие **цены для участия** нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#sponsored-discounts) **2. Оценка привлекательности цен на витрине.** Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#validation) В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/offers/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cofinancePriceFilter" : "SPECIFIED",
  "competitivenessFilter" : "OPTIMAL",
  "offerIds" : [ null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetOfferRecommendationsRequest getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferRecommendations: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetOfferRecommendationsRequest *getOfferRecommendationsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Рекомендации Маркета, касающиеся цен
[apiInstance getOfferRecommendationsWith:businessId
    getOfferRecommendationsRequest:getOfferRecommendationsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getOfferRecommendationsRequest = ; // {GetOfferRecommendationsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferRecommendations(businessId, getOfferRecommendationsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Рекомендации Маркета, касающиеся цен
                GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOfferRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferRecommendations($businessId, $getOfferRecommendationsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getOfferRecommendationsRequest = WWW::OPenAPIClient::Object::GetOfferRecommendationsRequest->new(); # GetOfferRecommendationsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferRecommendations(businessId => $businessId, getOfferRecommendationsRequest => $getOfferRecommendationsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOfferRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getOfferRecommendationsRequest =  # GetOfferRecommendationsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Рекомендации Маркета, касающиеся цен
    api_response = api_instance.get_offer_recommendations(businessId, getOfferRecommendationsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOfferRecommendations: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferRecommendationsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOffers

Предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?query=query_example&feedId=789&shopCategoryId=shopCategoryId_example¤cy=&matched=true&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String query = new String(); // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final String shopCategoryId = new String(); // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

final Boolean matched = new Boolean(); // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *query = query_example; // Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
String *shopCategoryId = shopCategoryId_example; // Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
CurrencyType *currency = ; // Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
Boolean *matched = true; // Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Предложения магазина
[apiInstance getOffersWith:campaignId
    query:query
    feedId:feedId
    shopCategoryId:shopCategoryId
    currency:currency
    matched:matched
    page:page
    pageSize:pageSize
              completionHandler: ^(GetOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'query': query_example, // {String} Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'shopCategoryId': shopCategoryId_example, // {String} Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

  'currency': , // {CurrencyType} Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

  'matched': true, // {Boolean} Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var query = query_example;  // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional)  (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var shopCategoryId = shopCategoryId_example;  // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional)  (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional)  (default to null)
            var matched = true;  // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Предложения магазина
                GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

$feedId = 789; // Long | Идентификатор прайс-листа.
$shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

$currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

$matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getOffers($campaignId, $query, $feedId, $shopCategoryId, $currency, $matched, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $query = query_example; # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $shopCategoryId = shopCategoryId_example; # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

my $currency = ; # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

my $matched = true; # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getOffers(campaignId => $campaignId, query => $query, feedId => $feedId, shopCategoryId => $shopCategoryId, currency => $currency, matched => $matched, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
query = query_example # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
shopCategoryId = shopCategoryId_example # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
currency =  # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
matched = true # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Предложения магазина
    api_response = api_instance.get_offers(campaignId, query=query, feedId=feedId, shopCategoryId=shopCategoryId, currency=currency, matched=matched, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let query = query_example; // String
    let feedId = 789; // Long
    let shopCategoryId = shopCategoryId_example; // String
    let currency = ; // CurrencyType
    let matched = true; // Boolean
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
query
String
Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId
Long (int64)
Идентификатор прайс-листа.
shopCategoryId
String
Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency
CurrencyType
Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.
matched
Boolean
Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOrder

Информация об одном заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrder");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrder(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrder: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация об одном заказе
[apiInstance getOrderWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация об одном заказе
                GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrder($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrder(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация об одном заказе
    api_response = api_instance.get_order(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrder: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOrder(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessBuyerInfo

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY`, `PICKUP` или `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/business-buyer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/business-buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessBuyerInfo: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — юридическом лице
[apiInstance getOrderBusinessBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — юридическом лице
                GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrderBusinessBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrderBusinessBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — юридическом лице
    api_response = api_instance.get_order_business_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrderBusinessBuyerInfo: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOrderBusinessBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessDocumentsInfo

Информация о документах

Возвращает информацию о документах по идентификатору заказа. Получить данные можно после того, как заказ перейдет в статус `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/documents

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessDocumentsInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessDocumentsInfo: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о документах
[apiInstance getOrderBusinessDocumentsInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessDocumentsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessDocumentsInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessDocumentsInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о документах
                GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrderBusinessDocumentsInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessDocumentsInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessDocumentsInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrderBusinessDocumentsInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о документах
    api_response = api_instance.get_order_business_documents_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrderBusinessDocumentsInfo: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOrderBusinessDocumentsInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBuyerInfo

Информация о покупателе — физическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом [POST campaigns/{campaignId}/orders/{orderId}/business-buyer](../../reference/order-business-information/getOrderBusinessBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY` или `PICKUP`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/buyer

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBuyerInfo: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — физическом лице
[apiInstance getOrderBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — физическом лице
                GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrderBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrderBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrderBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — физическом лице
    api_response = api_instance.get_order_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrderBuyerInfo: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOrderBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderLabelsData

Данные для самостоятельного изготовления ярлыков

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderLabelsData(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderLabelsData: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Данные для самостоятельного изготовления ярлыков
[apiInstance getOrderLabelsDataWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderLabelsDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderLabelsData(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderLabelsDataExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Данные для самостоятельного изготовления ярлыков
                GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrderLabelsData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderLabelsData($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrderLabelsData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderLabelsData(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrderLabelsData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Данные для самостоятельного изготовления ярлыков
    api_response = api_instance.get_order_labels_data(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrderLabelsData: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOrderLabelsData(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrders

Информация о нескольких заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * идентификаторам заказов; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) (если у вас есть идентификатор заказа) или запроса отчета по заказам [POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md). Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Для навигации по страницам используйте параметры `page_token` и `limit`. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders?orderIds=&status=&substatus=&fromDate=2013-10-20&toDate=2013-10-20&supplierShipmentDateFrom=2013-10-20&supplierShipmentDateTo=2013-10-20&updatedAtFrom=2013-10-20T19:20:30+01:00&updatedAtTo=2013-10-20T19:20:30+01:00&dispatchType=&fake=true&hasCis=true&onlyWaitingForCancellationApprove=true&onlyEstimatedDelivery=true&buyerType=&page=56&pageSize=56&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DbsApi#getOrders"); e.printStackTrace(); } } }
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[Long] orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. final set[OrderStatusType] status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. final set[OrderSubstatusType] substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. final date fromDate = new date(); // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. final date toDate = new date(); // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. final date supplierShipmentDateFrom = new date(); // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final date supplierShipmentDateTo = new date(); // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final Date updatedAtFrom = new Date(); // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final Date updatedAtTo = new Date(); // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final OrderDeliveryDispatchType dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки final Boolean fake = new Boolean(); // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. final Boolean hasCis = new Boolean(); // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. final Boolean onlyWaitingForCancellationApprove = new Boolean(); // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). final Boolean onlyEstimatedDelivery = new Boolean(); // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. final OrderBuyerType buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. final Integer page = new Integer(); // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. final Integer pageSize = new Integer(); // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. final String pageToken = new String(); // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. final Integer limit = new Integer(); // Integer | Количество значений на одной странице. try { final result = await api_instance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); print(result); } catch (e) { print('Exception when calling DefaultApi->getOrders: $e\n'); }
import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DbsApi#getOrders"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[Long] *orderIds = ; // Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) set[OrderStatusType] *status = ; // Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) set[OrderSubstatusType] *substatus = ; // Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) date *fromDate = 2013-10-20; // Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) date *toDate = 2013-10-20; // Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) date *supplierShipmentDateFrom = 2013-10-20; // Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) date *supplierShipmentDateTo = 2013-10-20; // Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtFrom = 2013-10-20T19:20:30+01:00; // Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtTo = 2013-10-20T19:20:30+01:00; // Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) OrderDeliveryDispatchType *dispatchType = ; // Способ отгрузки (optional) (default to null) Boolean *fake = true; // Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) Boolean *hasCis = true; // Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) Boolean *onlyWaitingForCancellationApprove = true; // **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) Boolean *onlyEstimatedDelivery = true; // Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) OrderBuyerType *buyerType = ; // Фильтрация заказов по типу покупателя. (optional) (default to null) Integer *page = 56; // Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) Integer *pageSize = 56; // Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) Integer *limit = 20; // Количество значений на одной странице. (optional) (default to null) // Информация о нескольких заказах [apiInstance getOrdersWith:campaignId orderIds:orderIds status:status substatus:substatus fromDate:fromDate toDate:toDate supplierShipmentDateFrom:supplierShipmentDateFrom supplierShipmentDateTo:supplierShipmentDateTo updatedAtFrom:updatedAtFrom updatedAtTo:updatedAtTo dispatchType:dispatchType fake:fake hasCis:hasCis onlyWaitingForCancellationApprove:onlyWaitingForCancellationApprove onlyEstimatedDelivery:onlyEstimatedDelivery buyerType:buyerType page:page pageSize:pageSize pageToken:pageToken limit:limit completionHandler: ^(GetOrdersResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'orderIds': , // {array[Long]} Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. 'status': , // {set[OrderStatusType]} Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. 'substatus': , // {set[OrderSubstatusType]} Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. 'fromDate': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. 'toDate': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. 'supplierShipmentDateFrom': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'supplierShipmentDateTo': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'updatedAtFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'updatedAtTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'dispatchType': , // {OrderDeliveryDispatchType} Способ отгрузки 'fake': true, // {Boolean} Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. 'hasCis': true, // {Boolean} Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. 'onlyWaitingForCancellationApprove': true, // {Boolean} **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). 'onlyEstimatedDelivery': true, // {Boolean} Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. 'buyerType': , // {OrderBuyerType} Фильтрация заказов по типу покупателя. 'page': 56, // {Integer} Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageSize': 56, // {Integer} Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. 'limit': 20 // {Integer} Количество значений на одной странице. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getOrders(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) var status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) var toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) var supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) var fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) var hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) var onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) var onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) var buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) var page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) var pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) var limit = 20; // Integer | Количество значений на одной странице. (optional) (default to null) try { // Информация о нескольких заказах GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DbsApi.getOrders: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. $status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. $substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. $fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. $toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. $supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки $fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. $hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. $onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). $onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. $buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. $page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. $pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. $limit = 20; // Integer | Количество значений на одной странице. try { $result = $api_instance->getOrders($campaignId, $orderIds, $status, $substatus, $fromDate, $toDate, $supplierShipmentDateFrom, $supplierShipmentDateTo, $updatedAtFrom, $updatedAtTo, $dispatchType, $fake, $hasCis, $onlyWaitingForCancellationApprove, $onlyEstimatedDelivery, $buyerType, $page, $pageSize, $pageToken, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling DbsApi->getOrders: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderIds = []; # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. my $status = []; # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. my $substatus = []; # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. my $fromDate = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. my $toDate = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. my $supplierShipmentDateFrom = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $supplierShipmentDateTo = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $updatedAtFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $updatedAtTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $dispatchType = ; # OrderDeliveryDispatchType | Способ отгрузки my $fake = true; # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. my $hasCis = true; # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. my $onlyWaitingForCancellationApprove = true; # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). my $onlyEstimatedDelivery = true; # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. my $buyerType = ; # OrderBuyerType | Фильтрация заказов по типу покупателя. my $page = 56; # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageSize = 56; # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. my $limit = 20; # Integer | Количество значений на одной странице. eval { my $result = $api_instance->getOrders(campaignId => $campaignId, orderIds => $orderIds, status => $status, substatus => $substatus, fromDate => $fromDate, toDate => $toDate, supplierShipmentDateFrom => $supplierShipmentDateFrom, supplierShipmentDateTo => $supplierShipmentDateTo, updatedAtFrom => $updatedAtFrom, updatedAtTo => $updatedAtTo, dispatchType => $dispatchType, fake => $fake, hasCis => $hasCis, onlyWaitingForCancellationApprove => $onlyWaitingForCancellationApprove, onlyEstimatedDelivery => $onlyEstimatedDelivery, buyerType => $buyerType, page => $page, pageSize => $pageSize, pageToken => $pageToken, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling DbsApi->getOrders: $@\n"; }
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderIds =  # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) status = # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) substatus = # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) fromDate = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) toDate = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) supplierShipmentDateFrom = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) supplierShipmentDateTo = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) updatedAtFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) updatedAtTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) dispatchType = # OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) fake = true # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) hasCis = true # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) onlyWaitingForCancellationApprove = true # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) onlyEstimatedDelivery = true # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) buyerType = # OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) page = 56 # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) pageSize = 56 # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) limit = 20 # Integer | Количество значений на одной странице. (optional) (default to null) try: # Информация о нескольких заказах api_response = api_instance.get_orders(campaignId, orderIds=orderIds, status=status, substatus=substatus, fromDate=fromDate, toDate=toDate, supplierShipmentDateFrom=supplierShipmentDateFrom, supplierShipmentDateTo=supplierShipmentDateTo, updatedAtFrom=updatedAtFrom, updatedAtTo=updatedAtTo, dispatchType=dispatchType, fake=fake, hasCis=hasCis, onlyWaitingForCancellationApprove=onlyWaitingForCancellationApprove, onlyEstimatedDelivery=onlyEstimatedDelivery, buyerType=buyerType, page=page, pageSize=pageSize, pageToken=pageToken, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling DbsApi->getOrders: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderIds = ; // array[Long]
    let status = ; // set[OrderStatusType]
    let substatus = ; // set[OrderSubstatusType]
    let fromDate = 2013-10-20; // date
    let toDate = 2013-10-20; // date
    let supplierShipmentDateFrom = 2013-10-20; // date
    let supplierShipmentDateTo = 2013-10-20; // date
    let updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date
    let updatedAtTo = 2013-10-20T19:20:30+01:00; // Date
    let dispatchType = ; // OrderDeliveryDispatchType
    let fake = true; // Boolean
    let hasCis = true; // Boolean
    let onlyWaitingForCancellationApprove = true; // Boolean
    let onlyEstimatedDelivery = true; // Boolean
    let buyerType = ; // OrderBuyerType
    let page = 56; // Integer
    let pageSize = 56; // Integer
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
orderIds
array[Long] (int64)
Фильтрация заказов по идентификаторам. <br><br> ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
status
set[OrderStatusType]
Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus
set[OrderSubstatusType]
Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.
fromDate
date (date)
Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
toDate
date (date)
Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.
supplierShipmentDateFrom
date (date)
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo
date (date)
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
updatedAtFrom
Date (date-time)
Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo
Date (date-time)
Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
dispatchType
OrderDeliveryDispatchType
Способ отгрузки
fake
Boolean
Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
hasCis
Boolean
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
onlyWaitingForCancellationApprove
Boolean
**Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
onlyEstimatedDelivery
Boolean
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
buyerType
OrderBuyerType
Фильтрация заказов по типу покупателя.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOrdersStats

Детальная информация по заказам

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п. {% note info "" %} Раньше генерация детальной информации по заказам называлась **Отчет по заказам**. Сейчас это новый отчет. [Подробнее об отчете](../../reference/reports/generateUnitedOrdersReport.md) {% endnote %} В одном запросе можно получить информацию не более чем по 200 заказам. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/stats/orders

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "updateTo" : "2000-01-23",
  "updateFrom" : "2000-01-23",
  "hasCis" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "CANCELLED_BEFORE_PROCESSING", "CANCELLED_BEFORE_PROCESSING" ],
  "orders" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOrdersStatsRequest getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest | 

try {
    final result = await api_instance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrdersStats: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOrdersStatsRequest *getOrdersStatsRequest = ; //  (optional)

// Детальная информация по заказам
[apiInstance getOrdersStatsWith:campaignId
    pageToken:pageToken
    limit:limit
    getOrdersStatsRequest:getOrdersStatsRequest
              completionHandler: ^(GetOrdersStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOrdersStatsRequest':  // {GetOrdersStatsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrdersStats(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest |  (optional) 

            try {
                // Детальная информация по заказам
                GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOrdersStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

try {
    $result = $api_instance->getOrdersStats($campaignId, $pageToken, $limit, $getOrdersStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOrdersStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOrdersStatsRequest = WWW::OPenAPIClient::Object::GetOrdersStatsRequest->new(); # GetOrdersStatsRequest | 

eval {
    my $result = $api_instance->getOrdersStats(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getOrdersStatsRequest => $getOrdersStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOrdersStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOrdersStatsRequest =  # GetOrdersStatsRequest |  (optional)

try:
    # Детальная информация по заказам
    api_response = api_instance.get_orders_stats(campaignId, pageToken=pageToken, limit=limit, getOrdersStatsRequest=getOrdersStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOrdersStats: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOrdersStatsRequest = ; // GetOrdersStatsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOrdersStatsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOutlet

Информация об одной точке продаж

Возвращает информацию о точках продаж магазина. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.

try {
    final result = await api_instance.getOutlet(campaignId, outletId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutlet: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)

// Информация об одной точке продаж
[apiInstance getOutletWith:campaignId
    outletId:outletId
              completionHandler: ^(GetOutletResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutlet(campaignId, outletId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)

            try {
                // Информация об одной точке продаж
                GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.

try {
    $result = $api_instance->getOutlet($campaignId, $outletId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.

eval {
    my $result = $api_instance->getOutlet(campaignId => $campaignId, outletId => $outletId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)

try:
    # Информация об одной точке продаж
    api_response = api_instance.get_outlet(campaignId, outletId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOutlet: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOutlet(campaignId, outletId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required

Responses


getOutletLicenses

Информация о лицензиях для точек продаж

Возвращает информацию о лицензиях для точек продаж. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses?outletIds=&ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final set[Long] outletIds = new set[Long](); // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

final set[Long] ids = new set[Long](); // set[Long] | Список идентификаторов лицензий.

try {
    final result = await api_instance.getOutletLicenses(campaignId, outletIds, ids);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutletLicenses: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
set[Long] *outletIds = ; // Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional) (default to null)
set[Long] *ids = ; // Список идентификаторов лицензий. (optional) (default to null)

// Информация о лицензиях для точек продаж
[apiInstance getOutletLicensesWith:campaignId
    outletIds:outletIds
    ids:ids
              completionHandler: ^(GetOutletLicensesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'outletIds': , // {set[Long]} Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

  'ids':  // {set[Long]} Список идентификаторов лицензий.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutletLicenses(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletIds = new set[Long](); // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional)  (default to null)
            var ids = new set[Long](); // set[Long] | Список идентификаторов лицензий. (optional)  (default to null)

            try {
                // Информация о лицензиях для точек продаж
                GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

$ids = ; // set[Long] | Список идентификаторов лицензий.

try {
    $result = $api_instance->getOutletLicenses($campaignId, $outletIds, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletIds = []; # set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

my $ids = []; # set[Long] | Список идентификаторов лицензий.

eval {
    my $result = $api_instance->getOutletLicenses(campaignId => $campaignId, outletIds => $outletIds, ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletIds =  # set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional) (default to null)
ids =  # set[Long] | Список идентификаторов лицензий. (optional) (default to null)

try:
    # Информация о лицензиях для точек продаж
    api_response = api_instance.get_outlet_licenses(campaignId, outletIds=outletIds, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOutletLicenses: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletIds = ; // set[Long]
    let ids = ; // set[Long]

    let mut context = DbsApi::Context::default();
    let result = client.getOutletLicenses(campaignId, outletIds, ids, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
outletIds
set[Long] (int64)
Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую. В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
ids
set[Long] (int64)
Список идентификаторов лицензий.

Responses


getOutlets

Информация о нескольких точках продаж

Возвращает список точек продаж магазина. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==®ion_id=789&shop_outlet_code=shopOutletCode_example®ionId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Long regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

        String shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
        Long regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


        try {
            GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutlets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Long regionId = new Long(); // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

final String shopOutletCode = new String(); // String | Идентификатор точки продаж, присвоенный магазином.
final Long regionId2 = new Long(); // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


try {
    final result = await api_instance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutlets: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Long regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

        String shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
        Long regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


        try {
            GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getOutlets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Long *regionId = 789; // Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional) (default to null)
String *shopOutletCode = shopOutletCode_example; // Идентификатор точки продаж, присвоенный магазином. (optional) (default to null)
Long *regionId2 = 789; // {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional) (default to null)

// Информация о нескольких точках продаж
[apiInstance getOutletsWith:campaignId
    pageToken:pageToken
    regionId:regionId
    shopOutletCode:shopOutletCode
    regionId2:regionId2
              completionHandler: ^(GetOutletsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'regionId': 789, // {Long} Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

  'shopOutletCode': shopOutletCode_example, // {String} Идентификатор точки продаж, присвоенный магазином.
  'regionId2': 789 // {Long} {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutlets(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var regionId = 789;  // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional)  (default to null)
            var shopOutletCode = shopOutletCode_example;  // String | Идентификатор точки продаж, присвоенный магазином. (optional)  (default to null)
            var regionId2 = 789;  // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional)  (default to null)

            try {
                // Информация о нескольких точках продаж
                GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getOutlets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

$shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
$regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


try {
    $result = $api_instance->getOutlets($campaignId, $pageToken, $regionId, $shopOutletCode, $regionId2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getOutlets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $regionId = 789; # Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

my $shopOutletCode = shopOutletCode_example; # String | Идентификатор точки продаж, присвоенный магазином.
my $regionId2 = 789; # Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


eval {
    my $result = $api_instance->getOutlets(campaignId => $campaignId, pageToken => $pageToken, regionId => $regionId, shopOutletCode => $shopOutletCode, regionId2 => $regionId2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getOutlets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
regionId = 789 # Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional) (default to null)
shopOutletCode = shopOutletCode_example # String | Идентификатор точки продаж, присвоенный магазином. (optional) (default to null)
regionId2 = 789 # Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional) (default to null)

try:
    # Информация о нескольких точках продаж
    api_response = api_instance.get_outlets(campaignId, pageToken=pageToken, regionId=regionId, shopOutletCode=shopOutletCode, regionId2=regionId2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getOutlets: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let regionId = 789; // Long
    let shopOutletCode = shopOutletCode_example; // String
    let regionId2 = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
region_id
Long (int64)
Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
shop_outlet_code
String
Идентификатор точки продаж, присвоенный магазином.
regionId
Long (int64)
{% note warning "" %} Этот параметр устарел. Для указания региона используйте `region_id`. {% endnote %}

Responses


getPrices

Список цен

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST campaigns/{campaignId}/offer-prices](../../reference/assortment/getPricesByOfferIds.md). {% endnote %} Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом. {% note info %} Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов. {% endnote %} Способы установки цен описаны [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/assortment/operations/prices.html). |**⚙️ Лимит:** ```(количество товаров партнера на витрине) * 25``` товаров в сутки| |-|


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&archived=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Boolean archived = new Boolean(); // Boolean | Фильтр по нахождению в архиве.

try {
    final result = await api_instance.getPrices(campaignId, pageToken, limit, archived);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Boolean *archived = true; // Фильтр по нахождению в архиве. (optional) (default to false)

// Список цен
[apiInstance getPricesWith:campaignId
    pageToken:pageToken
    limit:limit
    archived:archived
              completionHandler: ^(GetPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'archived': true // {Boolean} Фильтр по нахождению в архиве.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrices(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var archived = true;  // Boolean | Фильтр по нахождению в архиве. (optional)  (default to false)

            try {
                // Список цен
                GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$archived = true; // Boolean | Фильтр по нахождению в архиве.

try {
    $result = $api_instance->getPrices($campaignId, $pageToken, $limit, $archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $archived = true; # Boolean | Фильтр по нахождению в архиве.

eval {
    my $result = $api_instance->getPrices(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, archived => $archived);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
archived = true # Boolean | Фильтр по нахождению в архиве. (optional) (default to false)

try:
    # Список цен
    api_response = api_instance.get_prices(campaignId, pageToken=pageToken, limit=limit, archived=archived)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getPrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let archived = true; // Boolean

    let mut context = DbsApi::Context::default();
    let result = client.getPrices(campaignId, pageToken, limit, archived, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
archived
Boolean
Фильтр по нахождению в архиве.

Responses


getPricesByOfferIds

Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине. {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для просмотра базовых цен используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров на витрине * 25)


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest | 

try {
    final result = await api_instance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPricesByOfferIds: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetPricesByOfferIdsRequest *getPricesByOfferIdsRequest = ; //  (optional)

// Просмотр цен на указанные товары в магазине
[apiInstance getPricesByOfferIdsWith:campaignId
    pageToken:pageToken
    limit:limit
    getPricesByOfferIdsRequest:getPricesByOfferIdsRequest
              completionHandler: ^(GetPricesByOfferIdsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getPricesByOfferIdsRequest':  // {GetPricesByOfferIdsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPricesByOfferIds(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesByOfferIdsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest |  (optional) 

            try {
                // Просмотр цен на указанные товары в магазине
                GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getPricesByOfferIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

try {
    $result = $api_instance->getPricesByOfferIds($campaignId, $pageToken, $limit, $getPricesByOfferIdsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getPricesByOfferIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getPricesByOfferIdsRequest = WWW::OPenAPIClient::Object::GetPricesByOfferIdsRequest->new(); # GetPricesByOfferIdsRequest | 

eval {
    my $result = $api_instance->getPricesByOfferIds(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getPricesByOfferIdsRequest => $getPricesByOfferIdsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getPricesByOfferIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getPricesByOfferIdsRequest =  # GetPricesByOfferIdsRequest |  (optional)

try:
    # Просмотр цен на указанные товары в магазине
    api_response = api_instance.get_prices_by_offer_ids(campaignId, pageToken=pageToken, limit=limit, getPricesByOfferIdsRequest=getPricesByOfferIdsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getPricesByOfferIds: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPricesByOfferIdsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromoOffers

Получение списка товаров, которые участвуют или могут участвовать в акции

Возвращает список товаров, которые участвуют или могут участвовать в акции. {% note warning %} В параметре `limit` не передавайте значение больше 500. {% endnote %} |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "statusType" : "MANUALLY_ADDED",
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromoOffersRequest getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromoOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromoOffersRequest *getPromoOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение списка товаров, которые участвуют или могут участвовать в акции
[apiInstance getPromoOffersWith:businessId
    getPromoOffersRequest:getPromoOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetPromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getPromoOffersRequest = ; // {GetPromoOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromoOffers(businessId, getPromoOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение списка товаров, которые участвуют или могут участвовать в акции
                GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getPromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromoOffersRequest = ; // GetPromoOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getPromoOffers($businessId, $getPromoOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getPromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromoOffersRequest = WWW::OPenAPIClient::Object::GetPromoOffersRequest->new(); # GetPromoOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getPromoOffers(businessId => $businessId, getPromoOffersRequest => $getPromoOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getPromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromoOffersRequest =  # GetPromoOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение списка товаров, которые участвуют или могут участвовать в акции
    api_response = api_instance.get_promo_offers(businessId, getPromoOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getPromoOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromoOffersRequest = ; // GetPromoOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromoOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromos

Получение списка акций

Возвращает информацию об акциях Маркета. По умолчанию возвращаются акции, в которых продавец участвует или может принять участие. Чтобы получить текущие или завершенные акции, передайте параметр `participation`. Типы акций, которые возвращаются в ответе: * прямая скидка; * флеш-акция; * скидка по промокоду. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/promos

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos" \
 -d '{
  "participation" : "PARTICIPATING_NOW",
  "mechanics" : "DIRECT_DISCOUNT"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPromos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromosRequest getPromosRequest = new GetPromosRequest(); // GetPromosRequest | 

try {
    final result = await api_instance.getPromos(businessId, getPromosRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromos: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getPromos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromosRequest *getPromosRequest = ; //  (optional)

// Получение списка акций
[apiInstance getPromosWith:businessId
    getPromosRequest:getPromosRequest
              completionHandler: ^(GetPromosResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getPromosRequest':  // {GetPromosRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromos(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromosExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromosRequest = new GetPromosRequest(); // GetPromosRequest |  (optional) 

            try {
                // Получение списка акций
                GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getPromos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromosRequest = ; // GetPromosRequest | 

try {
    $result = $api_instance->getPromos($businessId, $getPromosRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getPromos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromosRequest = WWW::OPenAPIClient::Object::GetPromosRequest->new(); # GetPromosRequest | 

eval {
    my $result = $api_instance->getPromos(businessId => $businessId, getPromosRequest => $getPromosRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getPromos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromosRequest =  # GetPromosRequest |  (optional)

try:
    # Получение списка акций
    api_response = api_instance.get_promos(businessId, getPromosRequest=getPromosRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getPromos: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromosRequest = ; // GetPromosRequest

    let mut context = DbsApi::Context::default();
    let result = client.getPromos(businessId, getPromosRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromosRequest

Responses


getQualityRatingDetails

Заказы, которые повлияли на индекс качества

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос [POST businesses/{businessId}/ratings/quality](../../reference/ratings/getQualityRatings.md). |**⚙️ Лимит:** 100000 запросов в час| |-|


/campaigns/{campaignId}/ratings/quality/details

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/ratings/quality/details"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getQualityRatingDetails(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatingDetails: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Заказы, которые повлияли на индекс качества
[apiInstance getQualityRatingDetailsWith:campaignId
              completionHandler: ^(GetQualityRatingDetailsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatingDetails(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Заказы, которые повлияли на индекс качества
                GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getQualityRatingDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getQualityRatingDetails($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getQualityRatingDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getQualityRatingDetails(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getQualityRatingDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Заказы, которые повлияли на индекс качества
    api_response = api_instance.get_quality_rating_details(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getQualityRatingDetails: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getQualityRatingDetails(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getQualityRatings

Индекс качества магазинов

Возвращает значение индекса качества магазинов и его составляющие. Подробнее об индексе качества читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/quality/score/). |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/ratings/quality

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality" \
 -d '{
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 0, 0, 0, 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQualityRatingRequest getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

try {
    final result = await api_instance.getQualityRatings(businessId, getQualityRatingRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQualityRatingRequest *getQualityRatingRequest = ; // 

// Индекс качества магазинов
[apiInstance getQualityRatingsWith:businessId
    getQualityRatingRequest:getQualityRatingRequest
              completionHandler: ^(GetQualityRatingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQualityRatingRequest = ; // {GetQualityRatingRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatings(businessId, getQualityRatingRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

            try {
                // Индекс качества магазинов
                GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getQualityRatings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQualityRatingRequest = ; // GetQualityRatingRequest | 

try {
    $result = $api_instance->getQualityRatings($businessId, $getQualityRatingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getQualityRatings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQualityRatingRequest = WWW::OPenAPIClient::Object::GetQualityRatingRequest->new(); # GetQualityRatingRequest | 

eval {
    my $result = $api_instance->getQualityRatings(businessId => $businessId, getQualityRatingRequest => $getQualityRatingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getQualityRatings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQualityRatingRequest =  # GetQualityRatingRequest | 

try:
    # Индекс качества магазинов
    api_response = api_instance.get_quality_ratings(businessId, getQualityRatingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getQualityRatings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getQualityRatingRequest = ; // GetQualityRatingRequest

    let mut context = DbsApi::Context::default();
    let result = client.getQualityRatings(businessId, getQualityRatingRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQualityRatingRequest *

Responses


getReportInfo

Получение заданного отчета

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. [Инструкция](../../step-by-step/reports.md) |**⚙️ Лимит:** 100 запросов в минуту| |-|


/reports/info/{reportId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/reports/info/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportId = new String(); // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    final result = await api_instance.getReportInfo(reportId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReportInfo: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
String *reportId = reportId_example; // Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

// Получение заданного отчета
[apiInstance getReportInfoWith:reportId
              completionHandler: ^(GetReportInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var reportId = reportId_example; // {String} Идентификатор отчета, который вы получили после запуска генерации.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportInfo(reportId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReportInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var reportId = reportId_example;  // String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

            try {
                // Получение заданного отчета
                GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getReportInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    $result = $api_instance->getReportInfo($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getReportInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $reportId = reportId_example; # String | Идентификатор отчета, который вы получили после запуска генерации.


eval {
    my $result = $api_instance->getReportInfo(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getReportInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
reportId = reportId_example # String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

try:
    # Получение заданного отчета
    api_response = api_instance.get_report_info(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getReportInfo: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let reportId = reportId_example; // String

    let mut context = DbsApi::Context::default();
    let result = client.getReportInfo(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
reportId*
String
Идентификатор отчета, который вы получили после запуска генерации.
Required

Responses


getReturn

Информация о невыкупе или возврате

Получает информацию по одному невыкупу или возврату. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturn");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturn(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturn: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Информация о невыкупе или возврате
[apiInstance getReturnWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(GetReturnResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturn(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Информация о невыкупе или возврате
                GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getReturn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturn($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturn(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Информация о невыкупе или возврате
    api_response = api_instance.get_return(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getReturn: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getReturn(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnApplication

Получение заявления на возврат

Загружает заявление покупателя на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturnApplication(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnApplication: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Получение заявления на возврат
[apiInstance getReturnApplicationWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnApplication(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnApplicationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Получение заявления на возврат
                File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getReturnApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturnApplication($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getReturnApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturnApplication(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getReturnApplication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Получение заявления на возврат
    api_response = api_instance.get_return_application(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getReturnApplication: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getReturnApplication(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnPhoto

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final Long itemId = new Long(); // Long | Идентификатор товара в возврате.
final String imageHash = new String(); // String | Хеш ссылки изображения для загрузки.

try {
    final result = await api_instance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnPhoto: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
Long *itemId = 789; // Идентификатор товара в возврате. (default to null)
String *imageHash = imageHash_example; // Хеш ссылки изображения для загрузки. (default to null)

// Получение фотографии возврата
[apiInstance getReturnPhotoWith:campaignId
    orderId:orderId
    returnId:returnId
    itemId:itemId
    imageHash:imageHash
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var itemId = 789; // {Long} Идентификатор товара в возврате.
var imageHash = imageHash_example; // {String} Хеш ссылки изображения для загрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnPhotoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var itemId = 789;  // Long | Идентификатор товара в возврате. (default to null)
            var imageHash = imageHash_example;  // String | Хеш ссылки изображения для загрузки. (default to null)

            try {
                // Получение фотографии возврата
                File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getReturnPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$itemId = 789; // Long | Идентификатор товара в возврате.
$imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

try {
    $result = $api_instance->getReturnPhoto($campaignId, $orderId, $returnId, $itemId, $imageHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $itemId = 789; # Long | Идентификатор товара в возврате.
my $imageHash = imageHash_example; # String | Хеш ссылки изображения для загрузки.

eval {
    my $result = $api_instance->getReturnPhoto(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, itemId => $itemId, imageHash => $imageHash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getReturnPhoto: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
itemId = 789 # Long | Идентификатор товара в возврате. (default to null)
imageHash = imageHash_example # String | Хеш ссылки изображения для загрузки. (default to null)

try:
    # Получение фотографии возврата
    api_response = api_instance.get_return_photo(campaignId, orderId, returnId, itemId, imageHash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getReturnPhoto: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let itemId = 789; // Long
    let imageHash = imageHash_example; // String

    let mut context = DbsApi::Context::default();
    let result = client.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
itemId*
Long (int64)
Идентификатор товара в возврате.
Required
imageHash*
String
Хеш ссылки изображения для загрузки.
Required

Responses


getReturns

Список невыкупов и возвратов

Получает список невыкупов и возвратов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос [GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}](../../reference/orders/getReturn.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/returns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&orderIds=&statuses=STARTED_BY_USER,WAITING_FOR_DECISION&type=&fromDate=2022-10-31&toDate=2022-11-30&from_date=2022-10-31&to_date=2022-11-30"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final array[Long] orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

final array[RefundStatusType] statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

final ReturnType type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

final date fromDate = new date(); // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date toDate = new date(); // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date fromDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

final date toDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    final result = await api_instance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturns: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getReturns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
array[Long] *orderIds = ; // Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
array[RefundStatusType] *statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
ReturnType *type = ; // Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
date *fromDate = 2022-10-31; // Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *toDate = 2022-11-30; // Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *fromDate2 = 2022-10-31; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
date *toDate2 = 2022-11-30; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

// Список невыкупов и возвратов
[apiInstance getReturnsWith:campaignId
    pageToken:pageToken
    limit:limit
    orderIds:orderIds
    statuses:statuses
    type:type
    fromDate:fromDate
    toDate:toDate
    fromDate2:fromDate2
    toDate2:toDate2
              completionHandler: ^(GetReturnsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'orderIds': , // {array[Long]} Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

  'statuses': STARTED_BY_USER,WAITING_FOR_DECISION, // {array[RefundStatusType]} Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

  'type': , // {ReturnType} Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

  'fromDate': 2022-10-31, // {date} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'toDate': 2022-11-30, // {date} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'fromDate2': 2022-10-31, // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

  'toDate2': 2022-11-30 // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturns(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional)  (default to null)
            var statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional)  (default to null)
            var type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional)  (default to null)
            var fromDate = 2022-10-31;  // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var toDate = 2022-11-30;  // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var fromDate2 = 2022-10-31;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)
            var toDate2 = 2022-11-30;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)

            try {
                // Список невыкупов и возвратов
                GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getReturns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

$type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

$fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

$toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    $result = $api_instance->getReturns($campaignId, $pageToken, $limit, $orderIds, $statuses, $type, $fromDate, $toDate, $fromDate2, $toDate2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getReturns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $orderIds = []; # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

my $statuses = [STARTED_BY_USER,WAITING_FOR_DECISION]; # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

my $type = ; # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

my $fromDate = 2022-10-31; # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $toDate = 2022-11-30; # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $fromDate2 = 2022-10-31; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

my $toDate2 = 2022-11-30; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


eval {
    my $result = $api_instance->getReturns(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, orderIds => $orderIds, statuses => $statuses, type => $type, fromDate => $fromDate, toDate => $toDate, fromDate2 => $fromDate2, toDate2 => $toDate2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getReturns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
orderIds =  # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
statuses = STARTED_BY_USER,WAITING_FOR_DECISION # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
type =  # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
fromDate = 2022-10-31 # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
toDate = 2022-11-30 # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
fromDate2 = 2022-10-31 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
toDate2 = 2022-11-30 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

try:
    # Список невыкупов и возвратов
    api_response = api_instance.get_returns(campaignId, pageToken=pageToken, limit=limit, orderIds=orderIds, statuses=statuses, type=type, fromDate=fromDate, toDate=toDate, fromDate2=fromDate2, toDate2=toDate2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getReturns: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let orderIds = ; // array[Long]
    let statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType]
    let type = ; // ReturnType
    let fromDate = 2022-10-31; // date
    let toDate = 2022-11-30; // date
    let fromDate2 = 2022-10-31; // date
    let toDate2 = 2022-11-30; // date

    let mut context = DbsApi::Context::default();
    let result = client.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
orderIds
array[Long] (int64)
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
statuses
array[RefundStatusType]
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
type
ReturnType
Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.
fromDate
date (date)
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
toDate
date (date)
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
from_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `fromDate`. {% endnote %} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
to_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `toDate`. {% endnote %} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Responses


getStocks

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для всех моделей) и об [оборачиваемости](*turnover) товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте `true` в поле `withTurnover`. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке Маркета для продавцов https://yandex.ru/support/marketplace/analytics/turnover.html.)


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "withTurnover" : false,
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetWarehouseStocksRequest getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest | 

try {
    final result = await api_instance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStocks: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetWarehouseStocksRequest *getWarehouseStocksRequest = ; //  (optional)

// Информация об остатках и оборачиваемости
[apiInstance getStocksWith:campaignId
    pageToken:pageToken
    limit:limit
    getWarehouseStocksRequest:getWarehouseStocksRequest
              completionHandler: ^(GetWarehouseStocksResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getWarehouseStocksRequest':  // {GetWarehouseStocksRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStocks(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest |  (optional) 

            try {
                // Информация об остатках и оборачиваемости
                GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

try {
    $result = $api_instance->getStocks($campaignId, $pageToken, $limit, $getWarehouseStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getWarehouseStocksRequest = WWW::OPenAPIClient::Object::GetWarehouseStocksRequest->new(); # GetWarehouseStocksRequest | 

eval {
    my $result = $api_instance->getStocks(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getWarehouseStocksRequest => $getWarehouseStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getWarehouseStocksRequest =  # GetWarehouseStocksRequest |  (optional)

try:
    # Информация об остатках и оборачиваемости
    api_response = api_instance.get_stocks(campaignId, pageToken=pageToken, limit=limit, getWarehouseStocksRequest=getWarehouseStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getStocks: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getWarehouseStocksRequest = ; // GetWarehouseStocksRequest

    let mut context = DbsApi::Context::default();
    let result = client.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getWarehouseStocksRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappingEntries

Рекомендованные карточки для товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/suggestions](../../reference/business-assortment/getSuggestedOfferMappings.md). {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/updates](../../reference/offer-mappings/updateOfferMappingEntries.md). В одном запросе можно получить не более 500 рекомендаций. |**⚙️ Лимит:** 100 000 рекомендаций в час| |-|


/campaigns/{campaignId}/offer-mapping-entries/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions" \
 -d '{
  "offers" : [ {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingEntriesRequest *getSuggestedOfferMappingEntriesRequest = ; // 

// Рекомендованные карточки для товаров
[apiInstance getSuggestedOfferMappingEntriesWith:campaignId
    getSuggestedOfferMappingEntriesRequest:getSuggestedOfferMappingEntriesRequest
              completionHandler: ^(GetSuggestedOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getSuggestedOfferMappingEntriesRequest = ; // {GetSuggestedOfferMappingEntriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

            try {
                // Рекомендованные карточки для товаров
                GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getSuggestedOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappingEntries($campaignId, $getSuggestedOfferMappingEntriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getSuggestedOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingEntriesRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingEntriesRequest->new(); # GetSuggestedOfferMappingEntriesRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappingEntries(campaignId => $campaignId, getSuggestedOfferMappingEntriesRequest => $getSuggestedOfferMappingEntriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getSuggestedOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingEntriesRequest =  # GetSuggestedOfferMappingEntriesRequest | 

try:
    # Рекомендованные карточки для товаров
    api_response = api_instance.get_suggested_offer_mapping_entries(campaignId, getSuggestedOfferMappingEntriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getSuggestedOfferMappingEntries: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest

    let mut context = DbsApi::Context::default();
    let result = client.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingEntriesRequest *

Responses


getSuggestedOfferMappings

Просмотр карточек на Маркете, которые подходят вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами. Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным. **Как пользоваться запросом** 1. Передайте Маркету список товаров, которые нужно проверить. 2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией. 3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида `https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>`. 4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать `marketSKU`, который ему подходит по вашему мнению. {% note info "𝓠 Как определить `marketSku` товара, найденного на Маркете?" %} 𝓐 Он есть в адресе страницы товара — расположен после `sku=`. Например, `https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016` {% endnote %} |**⚙️ Лимит:** 100 000 товаров в час| |-|


/businesses/{businessId}/offer-mappings/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/suggestions" \
 -d '{
  "offers" : [ {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingsRequest *getSuggestedOfferMappingsRequest = ; //  (optional)

// Просмотр карточек на Маркете, которые подходят вашим товарам
[apiInstance getSuggestedOfferMappingsWith:businessId
    getSuggestedOfferMappingsRequest:getSuggestedOfferMappingsRequest
              completionHandler: ^(GetSuggestedOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getSuggestedOfferMappingsRequest':  // {GetSuggestedOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest |  (optional) 

            try {
                // Просмотр карточек на Маркете, которые подходят вашим товарам
                GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getSuggestedOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappings($businessId, $getSuggestedOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getSuggestedOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingsRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingsRequest->new(); # GetSuggestedOfferMappingsRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappings(businessId => $businessId, getSuggestedOfferMappingsRequest => $getSuggestedOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getSuggestedOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingsRequest =  # GetSuggestedOfferMappingsRequest |  (optional)

try:
    # Просмотр карточек на Маркете, которые подходят вашим товарам
    api_response = api_instance.get_suggested_offer_mappings(businessId, getSuggestedOfferMappingsRequest=getSuggestedOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getSuggestedOfferMappings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest

    let mut context = DbsApi::Context::default();
    let result = client.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingsRequest

Responses


getSuggestedPrices

Цены для продвижения товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [отчет «Цены на рынке»](../../reference/reports/generatePricesReport.md). {% endnote %} {% note warning "" %} Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях. {% endnote %} Возвращает цены для продвижения товаров, которые вы размещаете на Маркете. Товары, для которых нужно получить цены, передаются в теле POST-запроса. Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене. Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения. Установить цены на товары можно с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md) или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете. Подробно об автоматическом управлении ценами рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/prices.html). |**⚙️ Лимит:** 100 000 товаров в час| |-|


/campaigns/{campaignId}/offer-prices/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions" \
 -d '{
  "offers" : [ {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SuggestPricesRequest suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

try {
    final result = await api_instance.getSuggestedPrices(campaignId, suggestPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedPrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SuggestPricesRequest *suggestPricesRequest = ; // 

// Цены для продвижения товаров
[apiInstance getSuggestedPricesWith:campaignId
    suggestPricesRequest:suggestPricesRequest
              completionHandler: ^(SuggestPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var suggestPricesRequest = ; // {SuggestPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedPrices(campaignId, suggestPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

            try {
                // Цены для продвижения товаров
                SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getSuggestedPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$suggestPricesRequest = ; // SuggestPricesRequest | 

try {
    $result = $api_instance->getSuggestedPrices($campaignId, $suggestPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getSuggestedPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $suggestPricesRequest = WWW::OPenAPIClient::Object::SuggestPricesRequest->new(); # SuggestPricesRequest | 

eval {
    my $result = $api_instance->getSuggestedPrices(campaignId => $campaignId, suggestPricesRequest => $suggestPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getSuggestedPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
suggestPricesRequest =  # SuggestPricesRequest | 

try:
    # Цены для продвижения товаров
    api_response = api_instance.get_suggested_prices(campaignId, suggestPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getSuggestedPrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let suggestPricesRequest = ; // SuggestPricesRequest

    let mut context = DbsApi::Context::default();
    let result = client.getSuggestedPrices(campaignId, suggestPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
suggestPricesRequest *

Responses


getWarehouses

Список складов и групп складов

Возвращает список складов и, если склады объединены, список групп складов. [Что такое группы складов и зачем они нужны](https://yandex.ru/support/marketplace/assortment/operations/stocks.html#unified-stocks) Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getWarehouses(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getWarehouses: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список складов и групп складов
[apiInstance getWarehousesWith:businessId
              completionHandler: ^(GetWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouses(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список складов и групп складов
                GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.getWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getWarehouses($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getWarehouses(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->getWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список складов и групп складов
    api_response = api_instance.get_warehouses(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->getWarehouses: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.getWarehouses(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


provideOrderDigitalCodes

Передача ключей цифровых товаров

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус `DELIVERED`. Ключ нужно передать в течение 30 минут после перехода заказа в статус `PROCESSING`. Если в один заказ входят несколько ключей, передавайте их все в одном запросе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods" \
 -d '{
  "items" : [ {
    "activate_till" : "2000-01-23",
    "code" : "code",
    "slip" : "slip",
    "id" : 0
  }, {
    "activate_till" : "2000-01-23",
    "code" : "code",
    "slip" : "slip",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

        try {
            EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#provideOrderDigitalCodes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = new ProvideOrderDigitalCodesRequest(); // ProvideOrderDigitalCodesRequest | 

try {
    final result = await api_instance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderDigitalCodes: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

        try {
            EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#provideOrderDigitalCodes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderDigitalCodesRequest *provideOrderDigitalCodesRequest = ; // 

// Передача ключей цифровых товаров
[apiInstance provideOrderDigitalCodesWith:campaignId
    orderId:orderId
    provideOrderDigitalCodesRequest:provideOrderDigitalCodesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderDigitalCodesRequest = ; // {ProvideOrderDigitalCodesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderDigitalCodesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderDigitalCodesRequest = new ProvideOrderDigitalCodesRequest(); // ProvideOrderDigitalCodesRequest | 

            try {
                // Передача ключей цифровых товаров
                EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.provideOrderDigitalCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

try {
    $result = $api_instance->provideOrderDigitalCodes($campaignId, $orderId, $provideOrderDigitalCodesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->provideOrderDigitalCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderDigitalCodesRequest = WWW::OPenAPIClient::Object::ProvideOrderDigitalCodesRequest->new(); # ProvideOrderDigitalCodesRequest | 

eval {
    my $result = $api_instance->provideOrderDigitalCodes(campaignId => $campaignId, orderId => $orderId, provideOrderDigitalCodesRequest => $provideOrderDigitalCodesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->provideOrderDigitalCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderDigitalCodesRequest =  # ProvideOrderDigitalCodesRequest | 

try:
    # Передача ключей цифровых товаров
    api_response = api_instance.provide_order_digital_codes(campaignId, orderId, provideOrderDigitalCodesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->provideOrderDigitalCodes: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest

    let mut context = DbsApi::Context::default();
    let result = client.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderDigitalCodesRequest *

Responses


provideOrderItemIdentifiers

Передача кодов маркировки единиц товара

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Передает Маркету коды маркировки для единиц товара в указанном заказе. Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. {% note warning %} Прежде чем работать с этим методом, обязательно прочтите [статью о работе с маркируемыми товарами](https://yandex.ru/support/marketplace/orders/cz.html). {% endnote %} Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/identifiers

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers" \
 -d '{
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

try {
    final result = await api_instance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderItemIdentifiers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderItemIdentifiersRequest *provideOrderItemIdentifiersRequest = ; // 

// Передача кодов маркировки единиц товара
[apiInstance provideOrderItemIdentifiersWith:campaignId
    orderId:orderId
    provideOrderItemIdentifiersRequest:provideOrderItemIdentifiersRequest
              completionHandler: ^(ProvideOrderItemIdentifiersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderItemIdentifiersRequest = ; // {ProvideOrderItemIdentifiersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderItemIdentifiersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

            try {
                // Передача кодов маркировки единиц товара
                ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.provideOrderItemIdentifiers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

try {
    $result = $api_instance->provideOrderItemIdentifiers($campaignId, $orderId, $provideOrderItemIdentifiersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->provideOrderItemIdentifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderItemIdentifiersRequest = WWW::OPenAPIClient::Object::ProvideOrderItemIdentifiersRequest->new(); # ProvideOrderItemIdentifiersRequest | 

eval {
    my $result = $api_instance->provideOrderItemIdentifiers(campaignId => $campaignId, orderId => $orderId, provideOrderItemIdentifiersRequest => $provideOrderItemIdentifiersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->provideOrderItemIdentifiers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderItemIdentifiersRequest =  # ProvideOrderItemIdentifiersRequest | 

try:
    # Передача кодов маркировки единиц товара
    api_response = api_instance.provide_order_item_identifiers(campaignId, orderId, provideOrderItemIdentifiersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->provideOrderItemIdentifiers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest

    let mut context = DbsApi::Context::default();
    let result = client.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderItemIdentifiersRequest *

Responses


putBidsForBusiness

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} ![](../../_images/api-boost.png) {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForBusiness(businessId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForBusiness: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок
[apiInstance putBidsForBusinessWith:businessId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForBusiness(businessId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок
                EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.putBidsForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForBusiness($businessId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForBusiness(businessId => $businessId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->putBidsForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок
    api_response = api_instance.put_bids_for_business(businessId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->putBidsForBusiness: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = DbsApi::Context::default();
    let result = client.putBidsForBusiness(businessId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


putBidsForCampaign

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или [PUT businesses/{businessId}/bids](/reference/bids/putBidsForBusiness). Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/campaigns/{campaignId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForCampaign(campaignId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForCampaign: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок для магазина
[apiInstance putBidsForCampaignWith:campaignId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForCampaign(campaignId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок для магазина
                EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.putBidsForCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForCampaign($campaignId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForCampaign(campaignId => $campaignId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->putBidsForCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок для магазина
    api_response = api_instance.put_bids_for_campaign(campaignId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->putBidsForCampaign: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = DbsApi::Context::default();
    let result = client.putBidsForCampaign(campaignId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


refreshFeed

Сообщить, что прайс-лист обновился

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом `POST campaigns/{campaignId}/feeds/{feedId}/refresh`. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — `200 OK`. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.refreshFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshFeed: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Сообщить, что прайс-лист обновился
[apiInstance refreshFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class refreshFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Сообщить, что прайс-лист обновился
                EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.refreshFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->refreshFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->refreshFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->refreshFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Сообщить, что прайс-лист обновился
    api_response = api_instance.refresh_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->refreshFeed: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.refreshFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


searchModels

Поиск модели товара

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models?query=query_example®ionId=789¤cy=&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        String query = query_example; // String | Поисковый запрос по названию модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchModels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | Поисковый запрос по названию модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchModels(query, regionId, currency, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchModels: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        String query = query_example; // String | Поисковый запрос по названию модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchModels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
String *query = query_example; // Поисковый запрос по названию модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Поиск модели товара
[apiInstance searchModelsWith:query
    regionId:regionId
    currency:currency
    page:page
    pageSize:pageSize
              completionHandler: ^(SearchModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var query = query_example; // {String} Поисковый запрос по названию модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchModels(query, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchModelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var query = query_example;  // String | Поисковый запрос по названию модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Поиск модели товара
                SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.searchModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$query = query_example; // String | Поисковый запрос по названию модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchModels($query, $regionId, $currency, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->searchModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $query = query_example; # String | Поисковый запрос по названию модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchModels(query => $query, regionId => $regionId, currency => $currency, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->searchModels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
query = query_example # String | Поисковый запрос по названию модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Поиск модели товара
    api_response = api_instance.search_models(query, regionId, currency=currency, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->searchModels: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let query = query_example; // String
    let regionId = 789; // Long
    let currency = ; // CurrencyType
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.searchModels(query, regionId, currency, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
query*
String
Поисковый запрос по названию модели товара.
Required
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionChildren

Информация о дочерних регионах

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}/children

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}/children?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchRegionChildren(regionId, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionChildren: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о дочерних регионах
[apiInstance searchRegionChildrenWith:regionId
    page:page
    pageSize:pageSize
              completionHandler: ^(GetRegionWithChildrenResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionChildren(regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionChildrenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о дочерних регионах
                GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.searchRegionChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchRegionChildren($regionId, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->searchRegionChildren: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchRegionChildren(regionId => $regionId, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->searchRegionChildren: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о дочерних регионах
    api_response = api_instance.search_region_children(regionId, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->searchRegionChildren: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let regionId = 789; // Long
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.searchRegionChildren(regionId, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionsById

Информация о регионе

Возвращает информацию о регионе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    final result = await api_instance.searchRegionsById(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsById: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

// Информация о регионе
[apiInstance searchRegionsByIdWith:regionId
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsById(regionId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

            try {
                // Информация о регионе
                GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.searchRegionsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    $result = $api_instance->searchRegionsById($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->searchRegionsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


eval {
    my $result = $api_instance->searchRegionsById(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->searchRegionsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

try:
    # Информация о регионе
    api_response = api_instance.search_regions_by_id(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->searchRegionsById: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let regionId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.searchRegionsById(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required

Responses


searchRegionsByName

Поиск регионов по их имени

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска. Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions?name=name_example&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchRegionsByName(name, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsByName: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
String *name = name_example; // Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Поиск регионов по их имени
[apiInstance searchRegionsByNameWith:name
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var name = name_example; // {String} Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsByName(name, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByNameExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var name = name_example;  // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Поиск регионов по их имени
                GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.searchRegionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchRegionsByName($name, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->searchRegionsByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $name = name_example; # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchRegionsByName(name => $name, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->searchRegionsByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
name = name_example # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Поиск регионов по их имени
    api_response = api_instance.search_regions_by_name(name, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->searchRegionsByName: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let name = name_example; // String
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = DbsApi::Context::default();
    let result = client.searchRegionsByName(name, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
name*
String
Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


sendFileToChat

Отправка файла в чат

Отправляет файл в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/file/send

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/file/send?chatId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final File file = new File(); // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    final result = await api_instance.sendFileToChat(businessId, chatId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendFileToChat: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
File *file = BINARY_DATA_HERE; // Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

// Отправка файла в чат
[apiInstance sendFileToChatWith:businessId
    chatId:chatId
    file:file
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var file = BINARY_DATA_HERE; // {File} Содержимое файла. Максимальный размер файла — 5 Мбайт.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFileToChat(businessId, chatId, file, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendFileToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var file = BINARY_DATA_HERE;  // File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

            try {
                // Отправка файла в чат
                EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.sendFileToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $api_instance->sendFileToChat($businessId, $chatId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $file = BINARY_DATA_HERE; # File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

eval {
    my $result = $api_instance->sendFileToChat(businessId => $businessId, chatId => $chatId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->sendFileToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
file = BINARY_DATA_HERE # File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

try:
    # Отправка файла в чат
    api_response = api_instance.send_file_to_chat(businessId, chatId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->sendFileToChat: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = DbsApi::Context::default();
    let result = client.sendFileToChat(businessId, chatId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Form parameters
Name Description
file*
File (binary)
Содержимое файла. Максимальный размер файла — 5 Мбайт.
Required
Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


sendMessageToChat

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/message

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/message?chatId=789" \
 -d '{
  "message" : "message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final SendMessageToChatRequest sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

try {
    final result = await api_instance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendMessageToChat: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
SendMessageToChatRequest *sendMessageToChatRequest = ; // 

// Отправка сообщения в чат
[apiInstance sendMessageToChatWith:businessId
    chatId:chatId
    sendMessageToChatRequest:sendMessageToChatRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var sendMessageToChatRequest = ; // {SendMessageToChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendMessageToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

            try {
                // Отправка сообщения в чат
                EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.sendMessageToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$sendMessageToChatRequest = ; // SendMessageToChatRequest | 

try {
    $result = $api_instance->sendMessageToChat($businessId, $chatId, $sendMessageToChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $sendMessageToChatRequest = WWW::OPenAPIClient::Object::SendMessageToChatRequest->new(); # SendMessageToChatRequest | 

eval {
    my $result = $api_instance->sendMessageToChat(businessId => $businessId, chatId => $chatId, sendMessageToChatRequest => $sendMessageToChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->sendMessageToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
sendMessageToChatRequest =  # SendMessageToChatRequest | 

try:
    # Отправка сообщения в чат
    api_response = api_instance.send_message_to_chat(businessId, chatId, sendMessageToChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->sendMessageToChat: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let sendMessageToChatRequest = ; // SendMessageToChatRequest

    let mut context = DbsApi::Context::default();
    let result = client.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
sendMessageToChatRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


setFeedParams

Изменение параметров прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: `name` (название параметра) и `value` (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: `name` (название параметра) и `delete=true` (удалить значение). |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/params

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/params" \
 -d '{
  "parameters" : [ {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  }, {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final SetFeedParamsRequest setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

try {
    final result = await api_instance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setFeedParams: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
SetFeedParamsRequest *setFeedParamsRequest = ; // 

// Изменение параметров прайс-листа
[apiInstance setFeedParamsWith:campaignId
    feedId:feedId
    setFeedParamsRequest:setFeedParamsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var setFeedParamsRequest = ; // {SetFeedParamsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFeedParams(campaignId, feedId, setFeedParamsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setFeedParamsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

            try {
                // Изменение параметров прайс-листа
                EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setFeedParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$setFeedParamsRequest = ; // SetFeedParamsRequest | 

try {
    $result = $api_instance->setFeedParams($campaignId, $feedId, $setFeedParamsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $setFeedParamsRequest = WWW::OPenAPIClient::Object::SetFeedParamsRequest->new(); # SetFeedParamsRequest | 

eval {
    my $result = $api_instance->setFeedParams(campaignId => $campaignId, feedId => $feedId, setFeedParamsRequest => $setFeedParamsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setFeedParams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
setFeedParamsRequest =  # SetFeedParamsRequest | 

try:
    # Изменение параметров прайс-листа
    api_response = api_instance.set_feed_params(campaignId, feedId, setFeedParamsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setFeedParams: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let setFeedParamsRequest = ; // SetFeedParamsRequest

    let mut context = DbsApi::Context::default();
    let result = client.setFeedParams(campaignId, feedId, setFeedParamsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Body parameters
Name Description
setFeedParamsRequest *

Responses


setOrderBoxLayout

Подготовка заказа

{% note tip "Подходит и для DBS" %} Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно. {% endnote %} Позволяет выполнить три операции: * передать Маркету информацию о распределении товаров по коробкам; * передать Маркету коды маркировки для товаров; * удалить товар из заказа, если его не оказалось на складе. Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус **Готов к отгрузке**. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново. ## Как передать информацию о распределении товаров В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов: * **Содержащие товары целиком.** Такая коробка может содержать сколько угодно единиц любых товаров. * **Содержащие часть товара.** Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок. ⚠️ Одна коробка не может содержать и товары целиком, и части товаров. ## Как передавать коды маркировки Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. [Что такое маркировка?](https://yandex.ru/support/marketplace/orders/cz.html) Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них. ## Как удалить товар из заказа Чтобы удалить товар из заказа: 1. Добавьте в запрос `allowRemove: true`. 2. Передайте распределение по коробкам без товара, который нужно удалить. {% note warning "Удаление нельзя отменить" %} Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится. {% endnote %} Чтобы удалить позицию целиком, не передавайте соответствующий `OrderBoxLayoutItemDTO`. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле `fullCount`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} ## Примеры {% cut "Товар умещается в коробку" %} Вот как будет выглядеть запрос, если в одной коробке едут: * три единицы одного товара, требующего маркировки; * одна единица другого товара, не требущего маркировки. ```json { "boxes": [ { "items": [ { "id": 123456, "fullCount": 3, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" }, { "cis": "010304109478gftJ14545762!\u001dhGt264" }, { "cis": "010304109478fRs28323ks23!\u001dhet201" } ] }, { "id": 654321, "fullCount": 1 } ] } ] } ``` {% endcut %} {% cut "Товар едет в разных коробках" %} Вот как будет выглядеть запрос, если товар едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} {% cut "Одинаковые товары, где каждый едет в нескольких коробках" %} Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/boxes" \
 -d '{
  "boxes" : [ {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  }, {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  } ],
  "allowRemove" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

try {
    final result = await api_instance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderBoxLayout: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderBoxLayoutRequest *setOrderBoxLayoutRequest = ; // 

// Подготовка заказа
[apiInstance setOrderBoxLayoutWith:campaignId
    orderId:orderId
    setOrderBoxLayoutRequest:setOrderBoxLayoutRequest
              completionHandler: ^(SetOrderBoxLayoutResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderBoxLayoutRequest = ; // {SetOrderBoxLayoutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderBoxLayoutExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

            try {
                // Подготовка заказа
                SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setOrderBoxLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

try {
    $result = $api_instance->setOrderBoxLayout($campaignId, $orderId, $setOrderBoxLayoutRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setOrderBoxLayout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderBoxLayoutRequest = WWW::OPenAPIClient::Object::SetOrderBoxLayoutRequest->new(); # SetOrderBoxLayoutRequest | 

eval {
    my $result = $api_instance->setOrderBoxLayout(campaignId => $campaignId, orderId => $orderId, setOrderBoxLayoutRequest => $setOrderBoxLayoutRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setOrderBoxLayout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderBoxLayoutRequest =  # SetOrderBoxLayoutRequest | 

try:
    # Подготовка заказа
    api_response = api_instance.set_order_box_layout(campaignId, orderId, setOrderBoxLayoutRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setOrderBoxLayout: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest

    let mut context = DbsApi::Context::default();
    let result = client.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderBoxLayoutRequest *

Responses


setOrderDeliveryDate

Изменение даты доставки заказа

Метод изменяет дату доставки заказа в статусе `PROCESSING` или `DELIVERY`. Для заказов с другими статусами дату доставки изменить нельзя. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/date

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/date" \
 -d '{
  "reason" : "USER_MOVED_DELIVERY_DATES",
  "dates" : {
    "toDate" : "2000-01-23"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderDeliveryDate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = new SetOrderDeliveryDateRequest(); // SetOrderDeliveryDateRequest | 

try {
    final result = await api_instance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderDeliveryDate: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderDeliveryDate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderDeliveryDateRequest *setOrderDeliveryDateRequest = ; // 

// Изменение даты доставки заказа
[apiInstance setOrderDeliveryDateWith:campaignId
    orderId:orderId
    setOrderDeliveryDateRequest:setOrderDeliveryDateRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderDeliveryDateRequest = ; // {SetOrderDeliveryDateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderDeliveryDateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderDeliveryDateRequest = new SetOrderDeliveryDateRequest(); // SetOrderDeliveryDateRequest | 

            try {
                // Изменение даты доставки заказа
                EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setOrderDeliveryDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

try {
    $result = $api_instance->setOrderDeliveryDate($campaignId, $orderId, $setOrderDeliveryDateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setOrderDeliveryDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderDeliveryDateRequest = WWW::OPenAPIClient::Object::SetOrderDeliveryDateRequest->new(); # SetOrderDeliveryDateRequest | 

eval {
    my $result = $api_instance->setOrderDeliveryDate(campaignId => $campaignId, orderId => $orderId, setOrderDeliveryDateRequest => $setOrderDeliveryDateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setOrderDeliveryDate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderDeliveryDateRequest =  # SetOrderDeliveryDateRequest | 

try:
    # Изменение даты доставки заказа
    api_response = api_instance.set_order_delivery_date(campaignId, orderId, setOrderDeliveryDateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setOrderDeliveryDate: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest

    let mut context = DbsApi::Context::default();
    let result = client.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderDeliveryDateRequest *

Responses


setOrderDeliveryTrackCode

Передача трек‑номера посылки

{% note warning "Этот запрос только для DBS" %} Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти. {% endnote %} Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки. Передать трек‑номер можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY` или `PICKUP`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/track

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/track" \
 -d '{
  "trackCode" : "trackCode",
  "deliveryServiceId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderDeliveryTrackCode");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = new SetOrderDeliveryTrackCodeRequest(); // SetOrderDeliveryTrackCodeRequest | 

try {
    final result = await api_instance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderDeliveryTrackCode: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderDeliveryTrackCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderDeliveryTrackCodeRequest *setOrderDeliveryTrackCodeRequest = ; // 

// Передача трек‑номера посылки
[apiInstance setOrderDeliveryTrackCodeWith:campaignId
    orderId:orderId
    setOrderDeliveryTrackCodeRequest:setOrderDeliveryTrackCodeRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderDeliveryTrackCodeRequest = ; // {SetOrderDeliveryTrackCodeRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderDeliveryTrackCodeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderDeliveryTrackCodeRequest = new SetOrderDeliveryTrackCodeRequest(); // SetOrderDeliveryTrackCodeRequest | 

            try {
                // Передача трек‑номера посылки
                EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setOrderDeliveryTrackCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

try {
    $result = $api_instance->setOrderDeliveryTrackCode($campaignId, $orderId, $setOrderDeliveryTrackCodeRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setOrderDeliveryTrackCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderDeliveryTrackCodeRequest = WWW::OPenAPIClient::Object::SetOrderDeliveryTrackCodeRequest->new(); # SetOrderDeliveryTrackCodeRequest | 

eval {
    my $result = $api_instance->setOrderDeliveryTrackCode(campaignId => $campaignId, orderId => $orderId, setOrderDeliveryTrackCodeRequest => $setOrderDeliveryTrackCodeRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setOrderDeliveryTrackCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderDeliveryTrackCodeRequest =  # SetOrderDeliveryTrackCodeRequest | 

try:
    # Передача трек‑номера посылки
    api_response = api_instance.set_order_delivery_track_code(campaignId, orderId, setOrderDeliveryTrackCodeRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setOrderDeliveryTrackCode: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest

    let mut context = DbsApi::Context::default();
    let result = client.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderDeliveryTrackCodeRequest *

Responses


setOrderShipmentBoxes

Передача количества грузовых мест в заказе

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест. Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус **Готов к отгрузке**. Подробно о том, что в какой момент нужно передавать, рассказано в [пошаговой инструкции](../../step-by-step/fbs.md). Метод устроен немного нестандартно: количество задается длиной массива пустых объектов. Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому. {% cut "Как было раньше" %} Структура тела PUT-запроса: ``` { "boxes": [ { "fulfilmentId": "{string}", "weight": {int64}, "width": {int64}, "height": {int64}, "depth": {int64}, "items": [ { "id": {int64}, "count": {int32} }, ... ] }, ... ] } ``` | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `boxes` | | Список грузовых мест. | **Параметры, вложенные в `boxes`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `fulfilmentId` | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: `номер заказа на Маркете-номер грузового места`. Например, `7206821‑1, 7206821‑2` и т. д. | | `weight` | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | `width` | Int64 | Ширина грузового места в сантиметрах. | | `height` | Int64 | Высота грузового места в сантиметрах. | | `depth` | Int64 | Глубина грузового места в сантиметрах. | | `items` | Int64 | Список товаров в грузовом месте. | **Параметры, вложенные в `items`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `id` | Int64 | Идентификатор товара в рамках заказа. | | `count` | Int32 | Количество единиц товара в грузовом месте. | {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes" \
 -d '{
  "boxes" : [ {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  }, {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

final SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

try {
    final result = await api_instance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderShipmentBoxes: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
SetOrderShipmentBoxesRequest *setOrderShipmentBoxesRequest = ; // 

// Передача количества грузовых мест в заказе
[apiInstance setOrderShipmentBoxesWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    setOrderShipmentBoxesRequest:setOrderShipmentBoxesRequest
              completionHandler: ^(SetOrderShipmentBoxesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

var setOrderShipmentBoxesRequest = ; // {SetOrderShipmentBoxesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderShipmentBoxesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
            var setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

            try {
                // Передача количества грузовых мест в заказе
                SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setOrderShipmentBoxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

$setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

try {
    $result = $api_instance->setOrderShipmentBoxes($campaignId, $orderId, $shipmentId, $setOrderShipmentBoxesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setOrderShipmentBoxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

my $setOrderShipmentBoxesRequest = WWW::OPenAPIClient::Object::SetOrderShipmentBoxesRequest->new(); # SetOrderShipmentBoxesRequest | 

eval {
    my $result = $api_instance->setOrderShipmentBoxes(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, setOrderShipmentBoxesRequest => $setOrderShipmentBoxesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setOrderShipmentBoxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
setOrderShipmentBoxesRequest =  # SetOrderShipmentBoxesRequest | 

try:
    # Передача количества грузовых мест в заказе
    api_response = api_instance.set_order_shipment_boxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setOrderShipmentBoxes: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest

    let mut context = DbsApi::Context::default();
    let result = client.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
Required
Body parameters
Name Description
setOrderShipmentBoxesRequest *

Responses


setReturnDecision

Принятие или изменение решения по возврату

Выбирает решение по возврату от покупателя. После этого для подтверждения решения нужно выполнить запрос [POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit](../../reference/orders/submitReturnDecision.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision" \
 -d '{
  "returnItemId" : 1,
  "decisionType" : "REFUND_MONEY_INCLUDING_SHIPMENT",
  "comment" : "Вернуть 149 рублей за пересылку"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        SetReturnDecisionRequest setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

        try {
            EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setReturnDecision");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final SetReturnDecisionRequest setReturnDecisionRequest = new SetReturnDecisionRequest(); // SetReturnDecisionRequest | 

try {
    final result = await api_instance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setReturnDecision: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        SetReturnDecisionRequest setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

        try {
            EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#setReturnDecision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
SetReturnDecisionRequest *setReturnDecisionRequest = ; // 

// Принятие или изменение решения по возврату
[apiInstance setReturnDecisionWith:campaignId
    orderId:orderId
    returnId:returnId
    setReturnDecisionRequest:setReturnDecisionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var setReturnDecisionRequest = ; // {SetReturnDecisionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setReturnDecisionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var setReturnDecisionRequest = new SetReturnDecisionRequest(); // SetReturnDecisionRequest | 

            try {
                // Принятие или изменение решения по возврату
                EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.setReturnDecision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

try {
    $result = $api_instance->setReturnDecision($campaignId, $orderId, $returnId, $setReturnDecisionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->setReturnDecision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $setReturnDecisionRequest = WWW::OPenAPIClient::Object::SetReturnDecisionRequest->new(); # SetReturnDecisionRequest | 

eval {
    my $result = $api_instance->setReturnDecision(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, setReturnDecisionRequest => $setReturnDecisionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->setReturnDecision: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
setReturnDecisionRequest =  # SetReturnDecisionRequest | 

try:
    # Принятие или изменение решения по возврату
    api_response = api_instance.set_return_decision(campaignId, orderId, returnId, setReturnDecisionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->setReturnDecision: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let setReturnDecisionRequest = ; // SetReturnDecisionRequest

    let mut context = DbsApi::Context::default();
    let result = client.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
Body parameters
Name Description
setReturnDecisionRequest *

Responses


skipGoodsFeedbacksReaction

Отказ от ответа на отзывы

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов [POST businesses/{businessId}/goods-feedback](../../reference/goods-feedback/getGoodsFeedbacks.md). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/skip-reaction

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/skip-reaction" \
 -d '{
  "feedbackIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

try {
    final result = await api_instance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->skipGoodsFeedbacksReaction: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SkipGoodsFeedbackReactionRequest *skipGoodsFeedbackReactionRequest = ; // 

// Отказ от ответа на отзывы
[apiInstance skipGoodsFeedbacksReactionWith:businessId
    skipGoodsFeedbackReactionRequest:skipGoodsFeedbackReactionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var skipGoodsFeedbackReactionRequest = ; // {SkipGoodsFeedbackReactionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class skipGoodsFeedbacksReactionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

            try {
                // Отказ от ответа на отзывы
                EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.skipGoodsFeedbacksReaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

try {
    $result = $api_instance->skipGoodsFeedbacksReaction($businessId, $skipGoodsFeedbackReactionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->skipGoodsFeedbacksReaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $skipGoodsFeedbackReactionRequest = WWW::OPenAPIClient::Object::SkipGoodsFeedbackReactionRequest->new(); # SkipGoodsFeedbackReactionRequest | 

eval {
    my $result = $api_instance->skipGoodsFeedbacksReaction(businessId => $businessId, skipGoodsFeedbackReactionRequest => $skipGoodsFeedbackReactionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->skipGoodsFeedbacksReaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
skipGoodsFeedbackReactionRequest =  # SkipGoodsFeedbackReactionRequest | 

try:
    # Отказ от ответа на отзывы
    api_response = api_instance.skip_goods_feedbacks_reaction(businessId, skipGoodsFeedbackReactionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->skipGoodsFeedbacksReaction: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest

    let mut context = DbsApi::Context::default();
    let result = client.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
skipGoodsFeedbackReactionRequest *

Responses


submitReturnDecision

Подтверждение решения по возврату

Подтверждает выбранное решение по возврату, отправленное в запросе [POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision](../../reference/orders/setReturnDecision.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#submitReturnDecision");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.submitReturnDecision(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->submitReturnDecision: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#submitReturnDecision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Подтверждение решения по возврату
[apiInstance submitReturnDecisionWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitReturnDecision(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class submitReturnDecisionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Подтверждение решения по возврату
                EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.submitReturnDecision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->submitReturnDecision($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->submitReturnDecision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->submitReturnDecision(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->submitReturnDecision: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Подтверждение решения по возврату
    api_response = api_instance.submit_return_decision(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->submitReturnDecision: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = DbsApi::Context::default();
    let result = client.submitReturnDecision(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


updateBusinessPrices

Установка цен на товары во всех магазинах

Устанавливает [базовые цены](*default-price). Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateBusinessPricesRequest updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

try {
    final result = await api_instance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateBusinessPrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateBusinessPricesRequest *updateBusinessPricesRequest = ; // 

// Установка цен на товары во всех магазинах
[apiInstance updateBusinessPricesWith:businessId
    updateBusinessPricesRequest:updateBusinessPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateBusinessPricesRequest = ; // {UpdateBusinessPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBusinessPrices(businessId, updateBusinessPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

            try {
                // Установка цен на товары во всех магазинах
                EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

try {
    $result = $api_instance->updateBusinessPrices($businessId, $updateBusinessPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateBusinessPricesRequest = WWW::OPenAPIClient::Object::UpdateBusinessPricesRequest->new(); # UpdateBusinessPricesRequest | 

eval {
    my $result = $api_instance->updateBusinessPrices(businessId => $businessId, updateBusinessPricesRequest => $updateBusinessPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateBusinessPricesRequest =  # UpdateBusinessPricesRequest | 

try:
    # Установка цен на товары во всех магазинах
    api_response = api_instance.update_business_prices(businessId, updateBusinessPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateBusinessPrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateBusinessPrices(businessId, updateBusinessPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateBusinessPricesRequest *

Responses


updateCampaignOffers

Изменение условий продажи товаров в магазине

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/update" \
 -d '{
  "offers" : [ {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateCampaignOffersRequest updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

try {
    final result = await api_instance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCampaignOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateCampaignOffersRequest *updateCampaignOffersRequest = ; // 

// Изменение условий продажи товаров в магазине
[apiInstance updateCampaignOffersWith:campaignId
    updateCampaignOffersRequest:updateCampaignOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateCampaignOffersRequest = ; // {UpdateCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCampaignOffers(campaignId, updateCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

            try {
                // Изменение условий продажи товаров в магазине
                EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

try {
    $result = $api_instance->updateCampaignOffers($campaignId, $updateCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateCampaignOffersRequest = WWW::OPenAPIClient::Object::UpdateCampaignOffersRequest->new(); # UpdateCampaignOffersRequest | 

eval {
    my $result = $api_instance->updateCampaignOffers(campaignId => $campaignId, updateCampaignOffersRequest => $updateCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateCampaignOffersRequest =  # UpdateCampaignOffersRequest | 

try:
    # Изменение условий продажи товаров в магазине
    api_response = api_instance.update_campaign_offers(campaignId, updateCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateCampaignOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateCampaignOffers(campaignId, updateCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateCampaignOffersRequest *

Responses


updateGoodsFeedbackComment

Добавление нового или изменение созданного комментария

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее. Для создания комментария к отзыву передайте только идентификатор отзыва `feedbackId`. Чтобы добавить комментарий к другому комментарию, передайте: * `feedbackId` — идентификатор отзыва; * `comment.parentId` — идентификатор родительского комментария. Чтобы изменить комментарий, передайте: * `feedbackId`— идентификатор отзыва; * `comment.id` — идентификатор комментария, который нужно изменить. Если передать одновременно `comment.parentId` и `comment.id`, будет изменен существующий комментарий. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/update" \
 -d '{
  "feedbackId" : 0,
  "comment" : {
    "id" : 6,
    "text" : "text",
    "parentId" : 1
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateGoodsFeedbackCommentRequest *updateGoodsFeedbackCommentRequest = ; // 

// Добавление нового или изменение созданного комментария
[apiInstance updateGoodsFeedbackCommentWith:businessId
    updateGoodsFeedbackCommentRequest:updateGoodsFeedbackCommentRequest
              completionHandler: ^(UpdateGoodsFeedbackCommentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateGoodsFeedbackCommentRequest = ; // {UpdateGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

            try {
                // Добавление нового или изменение созданного комментария
                UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->updateGoodsFeedbackComment($businessId, $updateGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::UpdateGoodsFeedbackCommentRequest->new(); # UpdateGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->updateGoodsFeedbackComment(businessId => $businessId, updateGoodsFeedbackCommentRequest => $updateGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateGoodsFeedbackCommentRequest =  # UpdateGoodsFeedbackCommentRequest | 

try:
    # Добавление нового или изменение созданного комментария
    api_response = api_instance.update_goods_feedback_comment(businessId, updateGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateGoodsFeedbackComment: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateGoodsFeedbackCommentRequest *

Responses


updateOfferContent

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Чтобы удалить характеристики, которые заданы в параметрах с типом `string`, передайте пустое значение. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/businesses/{businessId}/offer-cards/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards/update" \
 -d '{
  "offersContent" : [ {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferContentRequest updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

try {
    final result = await api_instance.updateOfferContent(businessId, updateOfferContentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferContent: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferContentRequest *updateOfferContentRequest = ; // 

// Редактирование категорийных характеристик товара
[apiInstance updateOfferContentWith:businessId
    updateOfferContentRequest:updateOfferContentRequest
              completionHandler: ^(UpdateOfferContentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferContentRequest = ; // {UpdateOfferContentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferContent(businessId, updateOfferContentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferContentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

            try {
                // Редактирование категорийных характеристик товара
                UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOfferContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferContentRequest = ; // UpdateOfferContentRequest | 

try {
    $result = $api_instance->updateOfferContent($businessId, $updateOfferContentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferContentRequest = WWW::OPenAPIClient::Object::UpdateOfferContentRequest->new(); # UpdateOfferContentRequest | 

eval {
    my $result = $api_instance->updateOfferContent(businessId => $businessId, updateOfferContentRequest => $updateOfferContentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOfferContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferContentRequest =  # UpdateOfferContentRequest | 

try:
    # Редактирование категорийных характеристик товара
    api_response = api_instance.update_offer_content(businessId, updateOfferContentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOfferContent: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferContentRequest = ; // UpdateOfferContentRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOfferContent(businessId, updateOfferContentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferContentRequest *

Responses


updateOfferMappingEntries

Добавление и редактирование товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре `shopSku` ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре `shopSku` ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/suggestions](../../reference/offer-mappings/getSuggestedOfferMappingEntries.md) или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус `NEED_CONTENT` (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус `NEED_INFO` (в описании товара не хватает информации) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5 000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-mapping-entries/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/updates" \
 -d '{
  "offerMappingEntries" : [ {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

try {
    final result = await api_instance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingEntryRequest *updateOfferMappingEntryRequest = ; // 

// Добавление и редактирование товаров в каталоге
[apiInstance updateOfferMappingEntriesWith:campaignId
    updateOfferMappingEntryRequest:updateOfferMappingEntryRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingEntryRequest = ; // {UpdateOfferMappingEntryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

            try {
                // Добавление и редактирование товаров в каталоге
                EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

try {
    $result = $api_instance->updateOfferMappingEntries($campaignId, $updateOfferMappingEntryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingEntryRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingEntryRequest->new(); # UpdateOfferMappingEntryRequest | 

eval {
    my $result = $api_instance->updateOfferMappingEntries(campaignId => $campaignId, updateOfferMappingEntryRequest => $updateOfferMappingEntryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingEntryRequest =  # UpdateOfferMappingEntryRequest | 

try:
    # Добавление и редактирование товаров в каталоге
    api_response = api_instance.update_offer_mapping_entries(campaignId, updateOfferMappingEntryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOfferMappingEntries: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingEntryRequest *

Responses


updateOfferMappings

Добавление товаров в каталог и изменение информации о них

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах. Список категорий Маркета можно получить с помощью запроса [POST categories/tree](../../reference/categories/getCategoriesTree.md), а характеристики товаров по категориям с помощью [POST category/{categoryId}/parameters](../../reference/content/getCategoryContentParameters.md). Чтобы **добавить новый товар**, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (**SKU на Маркете**) в поле `marketSKU`. Для **новых товаров** обязательно укажите параметры: `offerId`, `name`, `marketCategoryId` или `category`, `pictures`, `vendor`, `description`. Чтобы **отредактировать информацию о товаре**, передайте новые данные, указав в `offerId` соответствующий **ваш SKU**. Поля, в которых ничего не меняется, можно не передавать. Чтобы **удалить характеристики**, которые заданы в параметрах с типом `string`, передайте пустое значение. Параметр `offerId` должен быть **уникальным** для всех товаров, которые вы передаете. {% note warning "Правила использования SKU" %} * У каждого товара SKU должен быть свой. * SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. * Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update" \
 -d '{
  "offerMappings" : [ {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  } ],
  "onlyPartnerMediaContent" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingsRequest updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

try {
    final result = await api_instance.updateOfferMappings(businessId, updateOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappings: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingsRequest *updateOfferMappingsRequest = ; // 

// Добавление товаров в каталог и изменение информации о них
[apiInstance updateOfferMappingsWith:businessId
    updateOfferMappingsRequest:updateOfferMappingsRequest
              completionHandler: ^(UpdateOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingsRequest = ; // {UpdateOfferMappingsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappings(businessId, updateOfferMappingsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

            try {
                // Добавление товаров в каталог и изменение информации о них
                UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

try {
    $result = $api_instance->updateOfferMappings($businessId, $updateOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingsRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingsRequest->new(); # UpdateOfferMappingsRequest | 

eval {
    my $result = $api_instance->updateOfferMappings(businessId => $businessId, updateOfferMappingsRequest => $updateOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingsRequest =  # UpdateOfferMappingsRequest | 

try:
    # Добавление товаров в каталог и изменение информации о них
    api_response = api_instance.update_offer_mappings(businessId, updateOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOfferMappings: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOfferMappings(businessId, updateOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingsRequest *

Responses


updateOrderItems

Удаление товара из заказа или уменьшение числа единиц

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях: * покупатель уменьшил количество товара; * магазин не может поставить все товары в заказе. Для этого заказ должен находится в статусе `"status": "PROCESSING"` этапа обработки `"substatus": "STARTED"`. После передачи статуса `"substatus": "READY_TO_SHIP"` изменить состав невозможно. Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте `count` параметра `item`. Чтобы полностью удалить товар из заказа: * передайте значение `0`; или * не передавайте параметр `item`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} **Возврат денег покупателю** Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней: * при оплате банковской картой — с момента, когда магазин переведет заказ в статус `SHIPPED`; * при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/items

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/items" \
 -d '{
  "reason" : "PARTNER_REQUESTED_REMOVE",
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderItemRequest updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

try {
    final result = await api_instance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderItems: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderItemRequest *updateOrderItemRequest = ; // 

// Удаление товара из заказа или уменьшение числа единиц
[apiInstance updateOrderItemsWith:campaignId
    orderId:orderId
    updateOrderItemRequest:updateOrderItemRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderItemRequest = ; // {UpdateOrderItemRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrderItems(campaignId, orderId, updateOrderItemRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderItemsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

            try {
                // Удаление товара из заказа или уменьшение числа единиц
                apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOrderItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderItemRequest = ; // UpdateOrderItemRequest | 

try {
    $api_instance->updateOrderItems($campaignId, $orderId, $updateOrderItemRequest);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderItemRequest = WWW::OPenAPIClient::Object::UpdateOrderItemRequest->new(); # UpdateOrderItemRequest | 

eval {
    $api_instance->updateOrderItems(campaignId => $campaignId, orderId => $orderId, updateOrderItemRequest => $updateOrderItemRequest);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOrderItems: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderItemRequest =  # UpdateOrderItemRequest | 

try:
    # Удаление товара из заказа или уменьшение числа единиц
    api_instance.update_order_items(campaignId, orderId, updateOrderItemRequest)
except ApiException as e:
    print("Exception when calling DbsApi->updateOrderItems: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderItemRequest = ; // UpdateOrderItemRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOrderItems(campaignId, orderId, updateOrderItemRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderItemRequest *

Responses


updateOrderStatus

Изменение статуса одного заказа

Изменяет статус заказа. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/status

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/status" \
 -d '{
  "order" : {
    "delivery" : {
      "dates" : {
        "realDeliveryDate" : "2000-01-23"
      }
    },
    "substatus" : "RESERVATION_EXPIRED",
    "status" : "PLACING"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStatusRequest updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

try {
    final result = await api_instance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatus: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStatusRequest *updateOrderStatusRequest = ; // 

// Изменение статуса одного заказа
[apiInstance updateOrderStatusWith:campaignId
    orderId:orderId
    updateOrderStatusRequest:updateOrderStatusRequest
              completionHandler: ^(UpdateOrderStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStatusRequest = ; // {UpdateOrderStatusRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

            try {
                // Изменение статуса одного заказа
                UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOrderStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

try {
    $result = $api_instance->updateOrderStatus($campaignId, $orderId, $updateOrderStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOrderStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStatusRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusRequest->new(); # UpdateOrderStatusRequest | 

eval {
    my $result = $api_instance->updateOrderStatus(campaignId => $campaignId, orderId => $orderId, updateOrderStatusRequest => $updateOrderStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOrderStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStatusRequest =  # UpdateOrderStatusRequest | 

try:
    # Изменение статуса одного заказа
    api_response = api_instance.update_order_status(campaignId, orderId, updateOrderStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOrderStatus: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStatusRequest = ; // UpdateOrderStatusRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStatusRequest *

Responses


updateOrderStatuses

Изменение статусов нескольких заказов

Изменяет статусы нескольких заказов. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"`и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/status-update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/status-update" \
 -d '{
  "orders" : [ {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOrderStatusesRequest updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

try {
    final result = await api_instance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatuses: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOrderStatusesRequest *updateOrderStatusesRequest = ; // 

// Изменение статусов нескольких заказов
[apiInstance updateOrderStatusesWith:campaignId
    updateOrderStatusesRequest:updateOrderStatusesRequest
              completionHandler: ^(UpdateOrderStatusesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOrderStatusesRequest = ; // {UpdateOrderStatusesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatuses(campaignId, updateOrderStatusesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

            try {
                // Изменение статусов нескольких заказов
                UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOrderStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

try {
    $result = $api_instance->updateOrderStatuses($campaignId, $updateOrderStatusesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOrderStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOrderStatusesRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusesRequest->new(); # UpdateOrderStatusesRequest | 

eval {
    my $result = $api_instance->updateOrderStatuses(campaignId => $campaignId, updateOrderStatusesRequest => $updateOrderStatusesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOrderStatuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOrderStatusesRequest =  # UpdateOrderStatusesRequest | 

try:
    # Изменение статусов нескольких заказов
    api_response = api_instance.update_order_statuses(campaignId, updateOrderStatusesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOrderStatuses: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOrderStatuses(campaignId, updateOrderStatusesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOrderStatusesRequest *

Responses


updateOrderStorageLimit

Продление срока хранения заказа

Продлевает срок хранения заказа в пункте выдачи продавца. Заказ должен быть в статусе `PICKUP`. Продлить срок можно только один раз, не больше чем на 30 дней. Новый срок хранения можно получить в параметре `outletStorageLimitDate` запроса [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit" \
 -d '{
  "newDate" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStorageLimit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = new UpdateOrderStorageLimitRequest(); // UpdateOrderStorageLimitRequest | 

try {
    final result = await api_instance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStorageLimit: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOrderStorageLimit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStorageLimitRequest *updateOrderStorageLimitRequest = ; // 

// Продление срока хранения заказа
[apiInstance updateOrderStorageLimitWith:campaignId
    orderId:orderId
    updateOrderStorageLimitRequest:updateOrderStorageLimitRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStorageLimitRequest = ; // {UpdateOrderStorageLimitRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStorageLimitExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStorageLimitRequest = new UpdateOrderStorageLimitRequest(); // UpdateOrderStorageLimitRequest | 

            try {
                // Продление срока хранения заказа
                EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOrderStorageLimit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

try {
    $result = $api_instance->updateOrderStorageLimit($campaignId, $orderId, $updateOrderStorageLimitRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOrderStorageLimit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStorageLimitRequest = WWW::OPenAPIClient::Object::UpdateOrderStorageLimitRequest->new(); # UpdateOrderStorageLimitRequest | 

eval {
    my $result = $api_instance->updateOrderStorageLimit(campaignId => $campaignId, orderId => $orderId, updateOrderStorageLimitRequest => $updateOrderStorageLimitRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOrderStorageLimit: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStorageLimitRequest =  # UpdateOrderStorageLimitRequest | 

try:
    # Продление срока хранения заказа
    api_response = api_instance.update_order_storage_limit(campaignId, orderId, updateOrderStorageLimitRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOrderStorageLimit: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStorageLimitRequest *

Responses


updateOutlet

Изменение информации о точке продаж

Изменяет информацию о точке продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}" \
 -d '{
  "storagePeriod" : 0,
  "address" : {
    "number" : "number",
    "km" : 6,
    "regionId" : 0,
    "city" : "city",
    "street" : "street",
    "additional" : "additional",
    "estate" : "estate",
    "block" : "block",
    "building" : "building"
  },
  "visibility" : "HIDDEN",
  "isMain" : true,
  "shopOutletCode" : "shopOutletCode",
  "name" : "name",
  "phones" : [ "phones", "phones" ],
  "type" : "DEPOT",
  "coords" : "coords",
  "workingSchedule" : {
    "scheduleItems" : [ {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    }, {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    } ],
    "workInHoliday" : true
  },
  "deliveryRules" : [ {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  }, {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.
        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.
final ChangeOutletRequest changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

try {
    final result = await api_instance.updateOutlet(campaignId, outletId, changeOutletRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOutlet: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.
        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)
ChangeOutletRequest *changeOutletRequest = ; // 

// Изменение информации о точке продаж
[apiInstance updateOutletWith:campaignId
    outletId:outletId
    changeOutletRequest:changeOutletRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.
var changeOutletRequest = ; // {ChangeOutletRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOutlet(campaignId, outletId, changeOutletRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)
            var changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

            try {
                // Изменение информации о точке продаж
                EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.
$changeOutletRequest = ; // ChangeOutletRequest | 

try {
    $result = $api_instance->updateOutlet($campaignId, $outletId, $changeOutletRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.
my $changeOutletRequest = WWW::OPenAPIClient::Object::ChangeOutletRequest->new(); # ChangeOutletRequest | 

eval {
    my $result = $api_instance->updateOutlet(campaignId => $campaignId, outletId => $outletId, changeOutletRequest => $changeOutletRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)
changeOutletRequest =  # ChangeOutletRequest | 

try:
    # Изменение информации о точке продаж
    api_response = api_instance.update_outlet(campaignId, outletId, changeOutletRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOutlet: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long
    let changeOutletRequest = ; // ChangeOutletRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOutlet(campaignId, outletId, changeOutletRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required
Body parameters
Name Description
changeOutletRequest *

Responses


updateOutletLicenses

Создание и изменение лицензий для точек продаж

Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя. Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses" \
 -d '{
  "licenses" : [ {
    "licenseType" : "ALCOHOL",
    "number" : "number",
    "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
    "outletId" : 6,
    "id" : 0,
    "dateOfIssue" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "licenseType" : "ALCOHOL",
    "number" : "number",
    "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
    "outletId" : 6,
    "id" : 0,
    "dateOfIssue" : "2000-01-23T04:56:07.000+00:00"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOutletLicenseRequest updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOutletLicenseRequest updateOutletLicenseRequest = new UpdateOutletLicenseRequest(); // UpdateOutletLicenseRequest | 

try {
    final result = await api_instance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOutletLicenses: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOutletLicenseRequest updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOutletLicenseRequest *updateOutletLicenseRequest = ; // 

// Создание и изменение лицензий для точек продаж
[apiInstance updateOutletLicensesWith:campaignId
    updateOutletLicenseRequest:updateOutletLicenseRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOutletLicenseRequest = ; // {UpdateOutletLicenseRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOutletLicenses(campaignId, updateOutletLicenseRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOutletLicenseRequest = new UpdateOutletLicenseRequest(); // UpdateOutletLicenseRequest | 

            try {
                // Создание и изменение лицензий для точек продаж
                EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

try {
    $result = $api_instance->updateOutletLicenses($campaignId, $updateOutletLicenseRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOutletLicenseRequest = WWW::OPenAPIClient::Object::UpdateOutletLicenseRequest->new(); # UpdateOutletLicenseRequest | 

eval {
    my $result = $api_instance->updateOutletLicenses(campaignId => $campaignId, updateOutletLicenseRequest => $updateOutletLicenseRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOutletLicenseRequest =  # UpdateOutletLicenseRequest | 

try:
    # Создание и изменение лицензий для точек продаж
    api_response = api_instance.update_outlet_licenses(campaignId, updateOutletLicenseRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateOutletLicenses: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateOutletLicenses(campaignId, updateOutletLicenseRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOutletLicenseRequest *

Responses


updatePrices

Установка цен на товары в конкретном магазине

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для управления базовыми ценами используйте [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updatePrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePricesRequest updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

try {
    final result = await api_instance.updatePrices(campaignId, updatePricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePrices: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updatePrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePricesRequest *updatePricesRequest = ; // 

// Установка цен на товары в конкретном магазине
[apiInstance updatePricesWith:campaignId
    updatePricesRequest:updatePricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePricesRequest = ; // {UpdatePricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePrices(campaignId, updatePricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

            try {
                // Установка цен на товары в конкретном магазине
                EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updatePrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePricesRequest = ; // UpdatePricesRequest | 

try {
    $result = $api_instance->updatePrices($campaignId, $updatePricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updatePrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePricesRequest = WWW::OPenAPIClient::Object::UpdatePricesRequest->new(); # UpdatePricesRequest | 

eval {
    my $result = $api_instance->updatePrices(campaignId => $campaignId, updatePricesRequest => $updatePricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updatePrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePricesRequest =  # UpdatePricesRequest | 

try:
    # Установка цен на товары в конкретном магазине
    api_response = api_instance.update_prices(campaignId, updatePricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updatePrices: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updatePricesRequest = ; // UpdatePricesRequest

    let mut context = DbsApi::Context::default();
    let result = client.updatePrices(campaignId, updatePricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePricesRequest *

Responses


updatePromoOffers

Добавление товаров в акцию или изменение их цен

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/update" \
 -d '{
  "offers" : [ {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  } ],
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePromoOffersRequest updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

try {
    final result = await api_instance.updatePromoOffers(businessId, updatePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePromoOffers: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePromoOffersRequest *updatePromoOffersRequest = ; // 

// Добавление товаров в акцию или изменение их цен
[apiInstance updatePromoOffersWith:businessId
    updatePromoOffersRequest:updatePromoOffersRequest
              completionHandler: ^(UpdatePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePromoOffersRequest = ; // {UpdatePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePromoOffers(businessId, updatePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

            try {
                // Добавление товаров в акцию или изменение их цен
                UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updatePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

try {
    $result = $api_instance->updatePromoOffers($businessId, $updatePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updatePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePromoOffersRequest = WWW::OPenAPIClient::Object::UpdatePromoOffersRequest->new(); # UpdatePromoOffersRequest | 

eval {
    my $result = $api_instance->updatePromoOffers(businessId => $businessId, updatePromoOffersRequest => $updatePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updatePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePromoOffersRequest =  # UpdatePromoOffersRequest | 

try:
    # Добавление товаров в акцию или изменение их цен
    api_response = api_instance.update_promo_offers(businessId, updatePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updatePromoOffers: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updatePromoOffersRequest = ; // UpdatePromoOffersRequest

    let mut context = DbsApi::Context::default();
    let result = client.updatePromoOffers(businessId, updatePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePromoOffersRequest *

Responses


updateStocks

Передача информации об остатках

Передает данные об остатках товаров на витрине. Обязательно указывайте SKU **в точности** так, как он указан в каталоге. Например, _557722_ и _0557722_ — это два разных SKU. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks" \
 -d '{
  "skus" : [ {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbsApi;

import java.io.File;
import java.util.*;

public class DbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateStocksRequest updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

try {
    final result = await api_instance.updateStocks(campaignId, updateStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStocks: $e\n');
}

import org.openapitools.client.api.DbsApi;

public class DbsApiExample {
    public static void main(String[] args) {
        DbsApi apiInstance = new DbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbsApi#updateStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DbsApi *apiInstance = [[DbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateStocksRequest *updateStocksRequest = ; // 

// Передача информации об остатках
[apiInstance updateStocksWith:campaignId
    updateStocksRequest:updateStocksRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateStocksRequest = ; // {UpdateStocksRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStocks(campaignId, updateStocksRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

            try {
                // Передача информации об остатках
                EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbsApi.updateStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateStocksRequest = ; // UpdateStocksRequest | 

try {
    $result = $api_instance->updateStocks($campaignId, $updateStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbsApi->updateStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateStocksRequest = WWW::OPenAPIClient::Object::UpdateStocksRequest->new(); # UpdateStocksRequest | 

eval {
    my $result = $api_instance->updateStocks(campaignId => $campaignId, updateStocksRequest => $updateStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbsApi->updateStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateStocksRequest =  # UpdateStocksRequest | 

try:
    # Передача информации об остатках
    api_response = api_instance.update_stocks(campaignId, updateStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbsApi->updateStocks: %s\n" % e)
extern crate DbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateStocksRequest = ; // UpdateStocksRequest

    let mut context = DbsApi::Context::default();
    let result = client.updateStocks(campaignId, updateStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateStocksRequest *

Responses


DeliveryServices

getDeliveryServices

Справочник служб доставки

Возвращает справочник служб доставки: идентификаторы и наименования. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/delivery/services

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/delivery/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeliveryServicesApi;

import java.io.File;
import java.util.*;

public class DeliveryServicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DeliveryServicesApi apiInstance = new DeliveryServicesApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryServicesApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDeliveryServices();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDeliveryServices: $e\n');
}

import org.openapitools.client.api.DeliveryServicesApi;

public class DeliveryServicesApiExample {
    public static void main(String[] args) {
        DeliveryServicesApi apiInstance = new DeliveryServicesApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryServicesApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DeliveryServicesApi *apiInstance = [[DeliveryServicesApi alloc] init];

// Справочник служб доставки
[apiInstance getDeliveryServicesWithCompletionHandler: 
              ^(GetDeliveryServicesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.DeliveryServicesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryServices(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getDeliveryServicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DeliveryServicesApi();

            try {
                // Справочник служб доставки
                GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeliveryServicesApi.getDeliveryServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeliveryServicesApi();

try {
    $result = $api_instance->getDeliveryServices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryServicesApi->getDeliveryServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeliveryServicesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeliveryServicesApi->new();

eval {
    my $result = $api_instance->getDeliveryServices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeliveryServicesApi->getDeliveryServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DeliveryServicesApi()

try:
    # Справочник служб доставки
    api_response = api_instance.get_delivery_services()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliveryServicesApi->getDeliveryServices: %s\n" % e)
extern crate DeliveryServicesApi;

pub fn main() {

    let mut context = DeliveryServicesApi::Context::default();
    let result = client.getDeliveryServices(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


Express

addHiddenOffers

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddHiddenOffersRequest addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

try {
    final result = await api_instance.addHiddenOffers(campaignId, addHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHiddenOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddHiddenOffersRequest *addHiddenOffersRequest = ; // 

// Скрытие товаров и настройки скрытия
[apiInstance addHiddenOffersWith:campaignId
    addHiddenOffersRequest:addHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addHiddenOffersRequest = ; // {AddHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addHiddenOffers(campaignId, addHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

            try {
                // Скрытие товаров и настройки скрытия
                EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.addHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

try {
    $result = $api_instance->addHiddenOffers($campaignId, $addHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->addHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addHiddenOffersRequest = WWW::OPenAPIClient::Object::AddHiddenOffersRequest->new(); # AddHiddenOffersRequest | 

eval {
    my $result = $api_instance->addHiddenOffers(campaignId => $campaignId, addHiddenOffersRequest => $addHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->addHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addHiddenOffersRequest =  # AddHiddenOffersRequest | 

try:
    # Скрытие товаров и настройки скрытия
    api_response = api_instance.add_hidden_offers(campaignId, addHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->addHiddenOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let addHiddenOffersRequest = ; // AddHiddenOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.addHiddenOffers(campaignId, addHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addHiddenOffersRequest *

Запрос на скрытие оферов.

Responses


addOffersToArchive

Добавление товаров в архив

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета. {% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %} Вначале такой товар нужно распродать или вывезти. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/archive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/archive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddOffersToArchiveRequest addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

try {
    final result = await api_instance.addOffersToArchive(businessId, addOffersToArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOffersToArchive: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddOffersToArchiveRequest *addOffersToArchiveRequest = ; // 

// Добавление товаров в архив
[apiInstance addOffersToArchiveWith:businessId
    addOffersToArchiveRequest:addOffersToArchiveRequest
              completionHandler: ^(AddOffersToArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addOffersToArchiveRequest = ; // {AddOffersToArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOffersToArchive(businessId, addOffersToArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addOffersToArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

            try {
                // Добавление товаров в архив
                AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.addOffersToArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

try {
    $result = $api_instance->addOffersToArchive($businessId, $addOffersToArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->addOffersToArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addOffersToArchiveRequest = WWW::OPenAPIClient::Object::AddOffersToArchiveRequest->new(); # AddOffersToArchiveRequest | 

eval {
    my $result = $api_instance->addOffersToArchive(businessId => $businessId, addOffersToArchiveRequest => $addOffersToArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->addOffersToArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addOffersToArchiveRequest =  # AddOffersToArchiveRequest | 

try:
    # Добавление товаров в архив
    api_response = api_instance.add_offers_to_archive(businessId, addOffersToArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->addOffersToArchive: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let addOffersToArchiveRequest = ; // AddOffersToArchiveRequest

    let mut context = ExpressApi::Context::default();
    let result = client.addOffersToArchive(businessId, addOffersToArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addOffersToArchiveRequest *

Responses


calculateTariffs

Калькулятор стоимости услуг

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги. Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг. В запросе можно указать либо параметр `campaignId`, либо `sellingProgram`. Совместное использование параметров приведет к ошибке. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/tariffs/calculate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/tariffs/calculate" \
 -d '{
  "offers" : [ {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  } ],
  "parameters" : {
    "campaignId" : 0,
    "sellingProgram" : "FBY",
    "frequency" : "DAILY"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CalculateTariffsRequest calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

try {
    final result = await api_instance.calculateTariffs(calculateTariffsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->calculateTariffs: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
CalculateTariffsRequest *calculateTariffsRequest = ; // 

// Калькулятор стоимости услуг
[apiInstance calculateTariffsWith:calculateTariffsRequest
              completionHandler: ^(CalculateTariffsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var calculateTariffsRequest = ; // {CalculateTariffsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateTariffs(calculateTariffsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class calculateTariffsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

            try {
                // Калькулятор стоимости услуг
                CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.calculateTariffs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$calculateTariffsRequest = ; // CalculateTariffsRequest | 

try {
    $result = $api_instance->calculateTariffs($calculateTariffsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->calculateTariffs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $calculateTariffsRequest = WWW::OPenAPIClient::Object::CalculateTariffsRequest->new(); # CalculateTariffsRequest | 

eval {
    my $result = $api_instance->calculateTariffs(calculateTariffsRequest => $calculateTariffsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->calculateTariffs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
calculateTariffsRequest =  # CalculateTariffsRequest | 

try:
    # Калькулятор стоимости услуг
    api_response = api_instance.calculate_tariffs(calculateTariffsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->calculateTariffs: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let calculateTariffsRequest = ; // CalculateTariffsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.calculateTariffs(calculateTariffsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
calculateTariffsRequest *

Responses


confirmBusinessPrices

Удаление товара из карантина по цене в кабинете

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина. Основная цена задается в каталоге и действует во всех магазинах кабинета. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST businesses/{businessId}/price-quarantine](getBusinessQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmBusinessPrices(businessId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmBusinessPrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в кабинете
[apiInstance confirmBusinessPricesWith:businessId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmBusinessPrices(businessId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в кабинете
                EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.confirmBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmBusinessPrices($businessId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->confirmBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmBusinessPrices(businessId => $businessId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->confirmBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в кабинете
    api_response = api_instance.confirm_business_prices(businessId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->confirmBusinessPrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.confirmBusinessPrices(businessId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmCampaignPrices

Удаление товара из карантина по цене в магазине

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST campaigns/{campaignId}/price-quarantine](getCampaignQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmCampaignPrices(campaignId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmCampaignPrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в магазине
[apiInstance confirmCampaignPricesWith:campaignId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmCampaignPrices(campaignId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmCampaignPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в магазине
                EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.confirmCampaignPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmCampaignPrices($campaignId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->confirmCampaignPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmCampaignPrices(campaignId => $campaignId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->confirmCampaignPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в магазине
    api_response = api_instance.confirm_campaign_prices(campaignId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->confirmCampaignPrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.confirmCampaignPrices(campaignId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


createChat

Создание нового чата с покупателем

Создает новый чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/new

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/new" \
 -d '{
  "orderId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#createChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final CreateChatRequest createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

try {
    final result = await api_instance.createChat(businessId, createChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createChat: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#createChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
CreateChatRequest *createChatRequest = ; // 

// Создание нового чата с покупателем
[apiInstance createChatWith:businessId
    createChatRequest:createChatRequest
              completionHandler: ^(CreateChatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var createChatRequest = ; // {CreateChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChat(businessId, createChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

            try {
                // Создание нового чата с покупателем
                CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.createChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$createChatRequest = ; // CreateChatRequest | 

try {
    $result = $api_instance->createChat($businessId, $createChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->createChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $createChatRequest = WWW::OPenAPIClient::Object::CreateChatRequest->new(); # CreateChatRequest | 

eval {
    my $result = $api_instance->createChat(businessId => $businessId, createChatRequest => $createChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->createChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
createChatRequest =  # CreateChatRequest | 

try:
    # Создание нового чата с покупателем
    api_response = api_instance.create_chat(businessId, createChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->createChat: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let createChatRequest = ; // CreateChatRequest

    let mut context = ExpressApi::Context::default();
    let result = client.createChat(businessId, createChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
createChatRequest *

description

Responses


deleteCampaignOffers

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteCampaignOffersRequest deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

try {
    final result = await api_instance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteCampaignOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteCampaignOffersRequest *deleteCampaignOffersRequest = ; // 

// Удаление товаров из ассортимента магазина
[apiInstance deleteCampaignOffersWith:campaignId
    deleteCampaignOffersRequest:deleteCampaignOffersRequest
              completionHandler: ^(DeleteCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteCampaignOffersRequest = ; // {DeleteCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

            try {
                // Удаление товаров из ассортимента магазина
                DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deleteCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

try {
    $result = $api_instance->deleteCampaignOffers($campaignId, $deleteCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deleteCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteCampaignOffersRequest = WWW::OPenAPIClient::Object::DeleteCampaignOffersRequest->new(); # DeleteCampaignOffersRequest | 

eval {
    my $result = $api_instance->deleteCampaignOffers(campaignId => $campaignId, deleteCampaignOffersRequest => $deleteCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deleteCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteCampaignOffersRequest =  # DeleteCampaignOffersRequest | 

try:
    # Удаление товаров из ассортимента магазина
    api_response = api_instance.delete_campaign_offers(campaignId, deleteCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deleteCampaignOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteCampaignOffersRequest *

Responses


deleteGoodsFeedbackComment

Удаление комментария к отзыву

Удаляет комментарий магазина. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/delete" \
 -d '{
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteGoodsFeedbackCommentRequest *deleteGoodsFeedbackCommentRequest = ; // 

// Удаление комментария к отзыву
[apiInstance deleteGoodsFeedbackCommentWith:businessId
    deleteGoodsFeedbackCommentRequest:deleteGoodsFeedbackCommentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteGoodsFeedbackCommentRequest = ; // {DeleteGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

            try {
                // Удаление комментария к отзыву
                EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deleteGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->deleteGoodsFeedbackComment($businessId, $deleteGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deleteGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::DeleteGoodsFeedbackCommentRequest->new(); # DeleteGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->deleteGoodsFeedbackComment(businessId => $businessId, deleteGoodsFeedbackCommentRequest => $deleteGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deleteGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteGoodsFeedbackCommentRequest =  # DeleteGoodsFeedbackCommentRequest | 

try:
    # Удаление комментария к отзыву
    api_response = api_instance.delete_goods_feedback_comment(businessId, deleteGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deleteGoodsFeedbackComment: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteGoodsFeedbackCommentRequest *

Responses


deleteHiddenOffers

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers/delete" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteHiddenOffersRequest deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

try {
    final result = await api_instance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHiddenOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteHiddenOffersRequest *deleteHiddenOffersRequest = ; // 

// Возобновление показа товаров
[apiInstance deleteHiddenOffersWith:campaignId
    deleteHiddenOffersRequest:deleteHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteHiddenOffersRequest = ; // {DeleteHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

            try {
                // Возобновление показа товаров
                EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deleteHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

try {
    $result = $api_instance->deleteHiddenOffers($campaignId, $deleteHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deleteHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteHiddenOffersRequest = WWW::OPenAPIClient::Object::DeleteHiddenOffersRequest->new(); # DeleteHiddenOffersRequest | 

eval {
    my $result = $api_instance->deleteHiddenOffers(campaignId => $campaignId, deleteHiddenOffersRequest => $deleteHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deleteHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteHiddenOffersRequest =  # DeleteHiddenOffersRequest | 

try:
    # Возобновление показа товаров
    api_response = api_instance.delete_hidden_offers(campaignId, deleteHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deleteHiddenOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteHiddenOffersRequest *

Запрос на возобновление показа оферов.

Responses


deleteOffers

Удаление товаров из каталога

Удаляет товары из каталога. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersRequest deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

try {
    final result = await api_instance.deleteOffers(businessId, deleteOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersRequest *deleteOffersRequest = ; // 

// Удаление товаров из каталога
[apiInstance deleteOffersWith:businessId
    deleteOffersRequest:deleteOffersRequest
              completionHandler: ^(DeleteOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersRequest = ; // {DeleteOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffers(businessId, deleteOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

            try {
                // Удаление товаров из каталога
                DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deleteOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersRequest = ; // DeleteOffersRequest | 

try {
    $result = $api_instance->deleteOffers($businessId, $deleteOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deleteOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersRequest = WWW::OPenAPIClient::Object::DeleteOffersRequest->new(); # DeleteOffersRequest | 

eval {
    my $result = $api_instance->deleteOffers(businessId => $businessId, deleteOffersRequest => $deleteOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deleteOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersRequest =  # DeleteOffersRequest | 

try:
    # Удаление товаров из каталога
    api_response = api_instance.delete_offers(businessId, deleteOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deleteOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersRequest = ; // DeleteOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deleteOffers(businessId, deleteOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersRequest *

Responses


deleteOffersFromArchive

Удаление товаров из архива

Восстанавливает товары из архива. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/unarchive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/unarchive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

try {
    final result = await api_instance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffersFromArchive: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersFromArchiveRequest *deleteOffersFromArchiveRequest = ; // 

// Удаление товаров из архива
[apiInstance deleteOffersFromArchiveWith:businessId
    deleteOffersFromArchiveRequest:deleteOffersFromArchiveRequest
              completionHandler: ^(DeleteOffersFromArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersFromArchiveRequest = ; // {DeleteOffersFromArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersFromArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

            try {
                // Удаление товаров из архива
                DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deleteOffersFromArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

try {
    $result = $api_instance->deleteOffersFromArchive($businessId, $deleteOffersFromArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deleteOffersFromArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersFromArchiveRequest = WWW::OPenAPIClient::Object::DeleteOffersFromArchiveRequest->new(); # DeleteOffersFromArchiveRequest | 

eval {
    my $result = $api_instance->deleteOffersFromArchive(businessId => $businessId, deleteOffersFromArchiveRequest => $deleteOffersFromArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deleteOffersFromArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersFromArchiveRequest =  # DeleteOffersFromArchiveRequest | 

try:
    # Удаление товаров из архива
    api_response = api_instance.delete_offers_from_archive(businessId, deleteOffersFromArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deleteOffersFromArchive: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersFromArchiveRequest *

Responses


deletePromoOffers

Удаление товаров из акции

Убирает товары из акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete" \
 -d '{
  "deleteAllOffers" : true,
  "promoId" : "promoId",
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeletePromoOffersRequest deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

try {
    final result = await api_instance.deletePromoOffers(businessId, deletePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePromoOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeletePromoOffersRequest *deletePromoOffersRequest = ; // 

// Удаление товаров из акции
[apiInstance deletePromoOffersWith:businessId
    deletePromoOffersRequest:deletePromoOffersRequest
              completionHandler: ^(DeletePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deletePromoOffersRequest = ; // {DeletePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePromoOffers(businessId, deletePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deletePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

            try {
                // Удаление товаров из акции
                DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.deletePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

try {
    $result = $api_instance->deletePromoOffers($businessId, $deletePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->deletePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deletePromoOffersRequest = WWW::OPenAPIClient::Object::DeletePromoOffersRequest->new(); # DeletePromoOffersRequest | 

eval {
    my $result = $api_instance->deletePromoOffers(businessId => $businessId, deletePromoOffersRequest => $deletePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->deletePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deletePromoOffersRequest =  # DeletePromoOffersRequest | 

try:
    # Удаление товаров из акции
    api_response = api_instance.delete_promo_offers(businessId, deletePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->deletePromoOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let deletePromoOffersRequest = ; // DeletePromoOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.deletePromoOffers(businessId, deletePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deletePromoOffersRequest *

Responses


generateBoostConsolidatedReport

Отчет по бусту продаж

Запускает генерацию **сводного отчета по бусту продаж** за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/boost-consolidated/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/boost-consolidated/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBoostConsolidatedReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateBoostConsolidatedRequest *generateBoostConsolidatedRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по бусту продаж
[apiInstance generateBoostConsolidatedReportWith:generateBoostConsolidatedRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateBoostConsolidatedRequest = ; // {GenerateBoostConsolidatedRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateBoostConsolidatedReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по бусту продаж
                GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateBoostConsolidatedReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateBoostConsolidatedReport($generateBoostConsolidatedRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateBoostConsolidatedReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateBoostConsolidatedRequest = WWW::OPenAPIClient::Object::GenerateBoostConsolidatedRequest->new(); # GenerateBoostConsolidatedRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateBoostConsolidatedReport(generateBoostConsolidatedRequest => $generateBoostConsolidatedRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateBoostConsolidatedReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateBoostConsolidatedRequest =  # GenerateBoostConsolidatedRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по бусту продаж
    api_response = api_instance.generate_boost_consolidated_report(generateBoostConsolidatedRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateBoostConsolidatedReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateBoostConsolidatedRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateCompetitorsPositionReport

Отчет «Конкурентная позиция»

Запускает генерацию **отчета «Конкурентная позиция»** за заданный период. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/analytics/competitors.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). {% note info "Значение -1 в отчете" %} Если в CSV-файле в столбце **POSITION** стоит -1, в этот день не было заказов с товарами в указанной категории. {% endnote %} |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/competitors-position/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/competitors-position/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "categoryId" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateCompetitorsPositionReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateCompetitorsPositionReportRequest *generateCompetitorsPositionReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Конкурентная позиция»
[apiInstance generateCompetitorsPositionReportWith:generateCompetitorsPositionReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateCompetitorsPositionReportRequest = ; // {GenerateCompetitorsPositionReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateCompetitorsPositionReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Конкурентная позиция»
                GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateCompetitorsPositionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateCompetitorsPositionReport($generateCompetitorsPositionReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateCompetitorsPositionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateCompetitorsPositionReportRequest = WWW::OPenAPIClient::Object::GenerateCompetitorsPositionReportRequest->new(); # GenerateCompetitorsPositionReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest => $generateCompetitorsPositionReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateCompetitorsPositionReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateCompetitorsPositionReportRequest =  # GenerateCompetitorsPositionReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Конкурентная позиция»
    api_response = api_instance.generate_competitors_position_report(generateCompetitorsPositionReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateCompetitorsPositionReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateCompetitorsPositionReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsFeedbackReport

Отчет по отзывам о товарах

Запускает генерацию **отчета по отзывам о товарах**. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/marketing/plus-reviews#stat) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-feedback/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-feedback/generate?format=" \
 -d '{
  "businessId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsFeedbackReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateGoodsFeedbackRequest *generateGoodsFeedbackRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по отзывам о товарах
[apiInstance generateGoodsFeedbackReportWith:generateGoodsFeedbackRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateGoodsFeedbackRequest = ; // {GenerateGoodsFeedbackRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsFeedbackReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по отзывам о товарах
                GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateGoodsFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsFeedbackReport($generateGoodsFeedbackRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateGoodsFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GenerateGoodsFeedbackRequest->new(); # GenerateGoodsFeedbackRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsFeedbackReport(generateGoodsFeedbackRequest => $generateGoodsFeedbackRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateGoodsFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateGoodsFeedbackRequest =  # GenerateGoodsFeedbackRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по отзывам о товарах
    api_response = api_instance.generate_goods_feedback_report(generateGoodsFeedbackRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateGoodsFeedbackReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsFeedbackRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsRealizationReport

Отчет по реализации

Запускает генерацию **отчета по реализации** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#sales-report) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-realization/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-realization/generate?format=" \
 -d '{
  "month" : 2,
  "year" : 6,
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsRealizationReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateGoodsRealizationReportRequest *generateGoodsRealizationReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по реализации
[apiInstance generateGoodsRealizationReportWith:generateGoodsRealizationReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateGoodsRealizationReportRequest = ; // {GenerateGoodsRealizationReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsRealizationReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по реализации
                GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateGoodsRealizationReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsRealizationReport($generateGoodsRealizationReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateGoodsRealizationReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateGoodsRealizationReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsRealizationReportRequest->new(); # GenerateGoodsRealizationReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsRealizationReport(generateGoodsRealizationReportRequest => $generateGoodsRealizationReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateGoodsRealizationReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateGoodsRealizationReportRequest =  # GenerateGoodsRealizationReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по реализации
    api_response = api_instance.generate_goods_realization_report(generateGoodsRealizationReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateGoodsRealizationReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsRealizationReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateMassOrderLabelsReport

Готовые ярлыки‑наклейки на все коробки в нескольких заказах

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 1000 запросов в час| |-|


/reports/documents/labels/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/labels/generate?format=" \
 -d '{
  "businessId" : 0,
  "orderIds" : [ 6, 6, 6, 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    final result = await api_instance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateMassOrderLabelsReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateMassOrderLabelsRequest *generateMassOrderLabelsRequest = ; // 
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в нескольких заказах
[apiInstance generateMassOrderLabelsReportWith:generateMassOrderLabelsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateMassOrderLabelsRequest = ; // {GenerateMassOrderLabelsRequest} 
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateMassOrderLabelsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в нескольких заказах
                GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateMassOrderLabelsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    $result = $api_instance->generateMassOrderLabelsReport($generateMassOrderLabelsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateMassOrderLabelsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateMassOrderLabelsRequest = WWW::OPenAPIClient::Object::GenerateMassOrderLabelsRequest->new(); # GenerateMassOrderLabelsRequest | 
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

eval {
    my $result = $api_instance->generateMassOrderLabelsReport(generateMassOrderLabelsRequest => $generateMassOrderLabelsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateMassOrderLabelsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateMassOrderLabelsRequest =  # GenerateMassOrderLabelsRequest | 
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в нескольких заказах
    api_response = api_instance.generate_mass_order_labels_report(generateMassOrderLabelsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateMassOrderLabelsReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest
    let format = ; // PageFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateMassOrderLabelsRequest *

Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Responses


generateOrderLabel

Готовый ярлык‑наклейка для коробки в заказе

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Идентификатор грузоместа.
final Long boxId = new Long(); // Long | Идентификатор коробки.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabel: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Идентификатор грузоместа. (default to null)
Long *boxId = 789; // Идентификатор коробки. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовый ярлык‑наклейка для коробки в заказе
[apiInstance generateOrderLabelWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    boxId:boxId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Идентификатор грузоместа.
var boxId = 789; // {Long} Идентификатор коробки.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabel(campaignId, orderId, shipmentId, boxId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Идентификатор грузоместа. (default to null)
            var boxId = 789;  // Long | Идентификатор коробки. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовый ярлык‑наклейка для коробки в заказе
                File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateOrderLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Идентификатор грузоместа.
$boxId = 789; // Long | Идентификатор коробки.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabel($campaignId, $orderId, $shipmentId, $boxId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateOrderLabel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Идентификатор грузоместа.
my $boxId = 789; # Long | Идентификатор коробки.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabel(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, boxId => $boxId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateOrderLabel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Идентификатор грузоместа. (default to null)
boxId = 789 # Long | Идентификатор коробки. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовый ярлык‑наклейка для коробки в заказе
    api_response = api_instance.generate_order_label(campaignId, orderId, shipmentId, boxId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateOrderLabel: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let boxId = 789; // Long
    let format = ; // PageFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Идентификатор грузоместа.
Required
boxId*
Long (int64)
Идентификатор коробки.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generateOrderLabels

Готовые ярлыки‑наклейки на все коробки в одном заказе

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabels(campaignId, orderId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabels: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в одном заказе
[apiInstance generateOrderLabelsWith:campaignId
    orderId:orderId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabels(campaignId, orderId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в одном заказе
                File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateOrderLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabels($campaignId, $orderId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateOrderLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabels(campaignId => $campaignId, orderId => $orderId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateOrderLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в одном заказе
    api_response = api_instance.generate_order_labels(campaignId, orderId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateOrderLabels: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let format = ; // PageFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateOrderLabels(campaignId, orderId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generatePricesReport

Отчет «Цены на рынке»

Запускает генерацию **отчета «Цены на рынке»**. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/prices/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/prices/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "creationDateTo" : "2000-01-23",
  "campaignId" : 6,
  "businessId" : 0,
  "creationDateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GeneratePricesReportRequest generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generatePricesReport(generatePricesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generatePricesReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GeneratePricesReportRequest *generatePricesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Цены на рынке»
[apiInstance generatePricesReportWith:generatePricesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generatePricesReportRequest = ; // {GeneratePricesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generatePricesReport(generatePricesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generatePricesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Цены на рынке»
                GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generatePricesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generatePricesReportRequest = ; // GeneratePricesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generatePricesReport($generatePricesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generatePricesReportRequest = WWW::OPenAPIClient::Object::GeneratePricesReportRequest->new(); # GeneratePricesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generatePricesReport(generatePricesReportRequest => $generatePricesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generatePricesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generatePricesReportRequest =  # GeneratePricesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Цены на рынке»
    api_response = api_instance.generate_prices_report(generatePricesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generatePricesReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generatePricesReportRequest = ; // GeneratePricesReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generatePricesReport(generatePricesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generatePricesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShelfsStatisticsReport

Отчет по полкам

Запускает генерацию **сводного отчета по полкам** — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf). Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/shelf-statistics/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shelf-statistics/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "attributionType" : "CLICKS"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShelfsStatisticsReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateShelfsStatisticsRequest *generateShelfsStatisticsRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по полкам
[apiInstance generateShelfsStatisticsReportWith:generateShelfsStatisticsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateShelfsStatisticsRequest = ; // {GenerateShelfsStatisticsRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShelfsStatisticsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по полкам
                GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateShelfsStatisticsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShelfsStatisticsReport($generateShelfsStatisticsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateShelfsStatisticsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateShelfsStatisticsRequest = WWW::OPenAPIClient::Object::GenerateShelfsStatisticsRequest->new(); # GenerateShelfsStatisticsRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShelfsStatisticsReport(generateShelfsStatisticsRequest => $generateShelfsStatisticsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateShelfsStatisticsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateShelfsStatisticsRequest =  # GenerateShelfsStatisticsRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по полкам
    api_response = api_instance.generate_shelfs_statistics_report(generateShelfsStatisticsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateShelfsStatisticsReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShelfsStatisticsRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShowsSalesReport

Отчет «Аналитика продаж»

Запускает генерацию **отчета «Аналитика продаж»** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/shows-sales.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/shows-sales/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=" \
 -d '{
  "campaignId" : 6,
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "grouping" : "CATEGORIES"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShowsSalesReportRequest generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShowsSalesReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateShowsSalesReportRequest *generateShowsSalesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Аналитика продаж»
[apiInstance generateShowsSalesReportWith:generateShowsSalesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateShowsSalesReportRequest = ; // {GenerateShowsSalesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShowsSalesReport(generateShowsSalesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShowsSalesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Аналитика продаж»
                GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateShowsSalesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShowsSalesReport($generateShowsSalesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateShowsSalesReportRequest = WWW::OPenAPIClient::Object::GenerateShowsSalesReportRequest->new(); # GenerateShowsSalesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShowsSalesReport(generateShowsSalesReportRequest => $generateShowsSalesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateShowsSalesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateShowsSalesReportRequest =  # GenerateShowsSalesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Аналитика продаж»
    api_response = api_instance.generate_shows_sales_report(generateShowsSalesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateShowsSalesReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateShowsSalesReport(generateShowsSalesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShowsSalesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateStocksOnWarehousesReport

Отчет по остаткам на складах

Запускает генерацию **отчета по остаткам на складах**. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. * Для остальных моделей — об остатках на соответствующем складе магазина. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/stocks-on-warehouses/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "hasStocks" : true,
  "reportDate" : "2000-01-23",
  "campaignId" : 0,
  "warehouseIds" : [ 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateStocksOnWarehousesReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateStocksOnWarehousesReportRequest *generateStocksOnWarehousesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по остаткам на складах
[apiInstance generateStocksOnWarehousesReportWith:generateStocksOnWarehousesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateStocksOnWarehousesReportRequest = ; // {GenerateStocksOnWarehousesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateStocksOnWarehousesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по остаткам на складах
                GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateStocksOnWarehousesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateStocksOnWarehousesReport($generateStocksOnWarehousesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateStocksOnWarehousesReportRequest = WWW::OPenAPIClient::Object::GenerateStocksOnWarehousesReportRequest->new(); # GenerateStocksOnWarehousesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest => $generateStocksOnWarehousesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateStocksOnWarehousesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateStocksOnWarehousesReportRequest =  # GenerateStocksOnWarehousesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по остаткам на складах
    api_response = api_instance.generate_stocks_on_warehouses_report(generateStocksOnWarehousesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateStocksOnWarehousesReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateStocksOnWarehousesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedMarketplaceServicesReport

Отчет по стоимости услуг

Запускает генерацию **отчета по стоимости услуг** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports.html) Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-----------------------------|---------------------------------| |По дате начисления услуги |`dateFrom` и `dateTo` | |По дате формирования акта |`year` и `month` | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-marketplace-services/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-marketplace-services/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "yearFrom" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "monthFrom" : 2,
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 2, 2 ],
  "dateFrom" : "2000-01-23",
  "monthTo" : 7,
  "yearTo" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedMarketplaceServicesReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateUnitedMarketplaceServicesReportRequest *generateUnitedMarketplaceServicesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по стоимости услуг
[apiInstance generateUnitedMarketplaceServicesReportWith:generateUnitedMarketplaceServicesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateUnitedMarketplaceServicesReportRequest = ; // {GenerateUnitedMarketplaceServicesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedMarketplaceServicesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по стоимости услуг
                GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateUnitedMarketplaceServicesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedMarketplaceServicesReport($generateUnitedMarketplaceServicesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateUnitedMarketplaceServicesReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedMarketplaceServicesReportRequest->new(); # GenerateUnitedMarketplaceServicesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest => $generateUnitedMarketplaceServicesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateUnitedMarketplaceServicesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateUnitedMarketplaceServicesReportRequest =  # GenerateUnitedMarketplaceServicesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по стоимости услуг
    api_response = api_instance.generate_united_marketplace_services_report(generateUnitedMarketplaceServicesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateUnitedMarketplaceServicesReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedMarketplaceServicesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedNettingReport

Отчет по платежам

Запускает генерацию **отчета по платежам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/transactions.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-------------------------|---------------------------------------| |О платежах за период |`dateFrom` и `dateTo` | |О платежном поручении |`bankOrderId` и `bankOrderDateTime` | Заказать отчеты обоих типов одним запросом нельзя. |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-netting/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-netting/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "bankOrderId" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 1, 1 ],
  "dateFrom" : "2000-01-23",
  "bankOrderDateTime" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedNettingReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateUnitedNettingReportRequest *generateUnitedNettingReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по платежам
[apiInstance generateUnitedNettingReportWith:generateUnitedNettingReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateUnitedNettingReportRequest = ; // {GenerateUnitedNettingReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedNettingReport(generateUnitedNettingReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedNettingReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по платежам
                GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateUnitedNettingReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedNettingReport($generateUnitedNettingReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateUnitedNettingReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedNettingReportRequest->new(); # GenerateUnitedNettingReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedNettingReport(generateUnitedNettingReportRequest => $generateUnitedNettingReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateUnitedNettingReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateUnitedNettingReportRequest =  # GenerateUnitedNettingReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по платежам
    api_response = api_instance.generate_united_netting_report(generateUnitedNettingReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateUnitedNettingReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateUnitedNettingReport(generateUnitedNettingReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedNettingReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedOrdersReport

Отчет по заказам

Запускает генерацию **отчета по заказам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/orders.html) {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. [Как получить детальную информацию по заказам](../../reference/stats/getOrdersStats.md) {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-orders/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-orders/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 6, 6 ],
  "promoId" : "promoId",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedOrdersRequest generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedOrdersReport: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GenerateUnitedOrdersRequest *generateUnitedOrdersRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по заказам
[apiInstance generateUnitedOrdersReportWith:generateUnitedOrdersRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var generateUnitedOrdersRequest = ; // {GenerateUnitedOrdersRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedOrdersReport(generateUnitedOrdersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedOrdersReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по заказам
                GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.generateUnitedOrdersReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedOrdersReport($generateUnitedOrdersRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $generateUnitedOrdersRequest = WWW::OPenAPIClient::Object::GenerateUnitedOrdersRequest->new(); # GenerateUnitedOrdersRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedOrdersReport(generateUnitedOrdersRequest => $generateUnitedOrdersRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->generateUnitedOrdersReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
generateUnitedOrdersRequest =  # GenerateUnitedOrdersRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по заказам
    api_response = api_instance.generate_united_orders_report(generateUnitedOrdersRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->generateUnitedOrdersReport: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest
    let format = ; // ReportFormatType

    let mut context = ExpressApi::Context::default();
    let result = client.generateUnitedOrdersReport(generateUnitedOrdersRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedOrdersRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


getAllOffers

Все предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers/all

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/all?feedId=789&chunk=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer chunk = new Integer(); // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    final result = await api_instance.getAllOffers(campaignId, feedId, chunk);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
Integer *chunk = 56; // Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

// Все предложения магазина
[apiInstance getAllOffersWith:campaignId
    feedId:feedId
    chunk:chunk
              completionHandler: ^(GetAllOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'chunk': 56 // {Integer} Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getAllOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var chunk = 56;  // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional)  (default to null)

            try {
                // Все предложения магазина
                GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getAllOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    $result = $api_instance->getAllOffers($campaignId, $feedId, $chunk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getAllOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $chunk = 56; # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


eval {
    my $result = $api_instance->getAllOffers(campaignId => $campaignId, feedId => $feedId, chunk => $chunk);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getAllOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
chunk = 56 # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

try:
    # Все предложения магазина
    api_response = api_instance.get_all_offers(campaignId, feedId=feedId, chunk=chunk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getAllOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let chunk = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getAllOffers(campaignId, feedId, chunk, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
feedId
Long (int64)
Идентификатор прайс-листа.
chunk
Integer (int32)
Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}

Responses


getBidsInfoForBusiness

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/info

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | 

try {
    final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; //  (optional)

// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
    pageToken:pageToken
    limit:limit
    getBidsInfoRequest:getBidsInfoRequest
              completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getBidsInfoRequest':  // {GetBidsInfoRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsInfoForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |  (optional) 

            try {
                // Информация об установленных ставках
                GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getBidsInfoForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getBidsInfoRequest = ; // GetBidsInfoRequest | 

try {
    $result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest | 

eval {
    my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getBidsInfoRequest =  # GetBidsInfoRequest |  (optional)

try:
    # Информация об установленных ставках
    api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getBidsInfoForBusiness: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getBidsInfoRequest = ; // GetBidsInfoRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsInfoRequest

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBidsRecommendations

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetBidsRecommendationsRequest getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

try {
    final result = await api_instance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsRecommendations: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetBidsRecommendationsRequest *getBidsRecommendationsRequest = ; // 

// Рекомендованные ставки для заданных товаров
[apiInstance getBidsRecommendationsWith:businessId
    getBidsRecommendationsRequest:getBidsRecommendationsRequest
              completionHandler: ^(GetBidsRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getBidsRecommendationsRequest = ; // {GetBidsRecommendationsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsRecommendations(businessId, getBidsRecommendationsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

            try {
                // Рекомендованные ставки для заданных товаров
                GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getBidsRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

try {
    $result = $api_instance->getBidsRecommendations($businessId, $getBidsRecommendationsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getBidsRecommendationsRequest = WWW::OPenAPIClient::Object::GetBidsRecommendationsRequest->new(); # GetBidsRecommendationsRequest | 

eval {
    my $result = $api_instance->getBidsRecommendations(businessId => $businessId, getBidsRecommendationsRequest => $getBidsRecommendationsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getBidsRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getBidsRecommendationsRequest =  # GetBidsRecommendationsRequest | 

try:
    # Рекомендованные ставки для заданных товаров
    api_response = api_instance.get_bids_recommendations(businessId, getBidsRecommendationsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getBidsRecommendations: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getBidsRecommendations(businessId, getBidsRecommendationsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsRecommendationsRequest *

description.

Responses


getBusinessQuarantineOffers

Список товаров, находящихся в карантине по цене в кабинете

Возвращает список товаров, которые находятся в карантине по **основной цене**. Основная цена задается в каталоге и действует во всех магазинах кабинета. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST businesses/{businessId}/price-quarantine/confirm](../../reference/business-assortment/confirmBusinessPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessQuarantineOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в кабинете
[apiInstance getBusinessQuarantineOffersWith:businessId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в кабинете
                GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getBusinessQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getBusinessQuarantineOffers($businessId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getBusinessQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getBusinessQuarantineOffers(businessId => $businessId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getBusinessQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в кабинете
    api_response = api_instance.get_business_quarantine_offers(businessId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getBusinessQuarantineOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBusinessSettings

Настройки кабинета

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/settings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getBusinessSettings(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessSettings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки кабинета
[apiInstance getBusinessSettingsWith:businessId
              completionHandler: ^(GetBusinessSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessSettings(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки кабинета
                GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getBusinessSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getBusinessSettings($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getBusinessSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getBusinessSettings(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getBusinessSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки кабинета
    api_response = api_instance.get_business_settings(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getBusinessSettings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getBusinessSettings(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaign

Информация о магазине

Возвращает информацию о магазине. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaign(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaign: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Информация о магазине
[apiInstance getCampaignWith:campaignId
              completionHandler: ^(GetCampaignResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Информация о магазине
                GetCampaignResponse result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Информация о магазине
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaign: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignLogins

Логины, связанные с магазином

Возвращает список логинов, у которых есть доступ к магазину. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/logins

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/logins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignLogins(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignLogins: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Логины, связанные с магазином
[apiInstance getCampaignLoginsWith:campaignId
              completionHandler: ^(GetCampaignLoginsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignLogins(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignLoginsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Логины, связанные с магазином
                GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignLogins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignLogins($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignLogins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignLogins(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignLogins: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Логины, связанные с магазином
    api_response = api_instance.get_campaign_logins(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignLogins: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignLogins(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignOffers

Информация о товарах, которые размещены в заданном магазине

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "statuses" : [ "PUBLISHED", "PUBLISHED" ],
  "offerIds" : [ null, null, null, null, null ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetCampaignOffersRequest getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetCampaignOffersRequest *getCampaignOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Информация о товарах, которые размещены в заданном магазине
[apiInstance getCampaignOffersWith:campaignId
    getCampaignOffersRequest:getCampaignOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getCampaignOffersRequest = ; // {GetCampaignOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignOffers(campaignId, getCampaignOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Информация о товарах, которые размещены в заданном магазине
                GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignOffers($campaignId, $getCampaignOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getCampaignOffersRequest = WWW::OPenAPIClient::Object::GetCampaignOffersRequest->new(); # GetCampaignOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignOffers(campaignId => $campaignId, getCampaignOffersRequest => $getCampaignOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getCampaignOffersRequest =  # GetCampaignOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Информация о товарах, которые размещены в заданном магазине
    api_response = api_instance.get_campaign_offers(campaignId, getCampaignOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let getCampaignOffersRequest = ; // GetCampaignOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getCampaignOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignQuarantineOffers

Список товаров, находящихся в карантине по цене в магазине

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST campaigns/{campaignId}/price-quarantine/confirm](../../reference/assortment/confirmCampaignPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignQuarantineOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в магазине
[apiInstance getCampaignQuarantineOffersWith:campaignId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в магазине
                GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignQuarantineOffers($campaignId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignQuarantineOffers(campaignId => $campaignId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в магазине
    api_response = api_instance.get_campaign_quarantine_offers(campaignId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignQuarantineOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignRegion

Регион магазина

{% note warning "" %} Этот метод устарел. Вместо него используйте [GET campaigns/{campaignId}/settings](../../reference/campaigns/getCampaignSettings.md). {% endnote %} Возвращает регион, в котором находится магазин. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/campaigns/{campaignId}/region

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignRegion(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignRegion: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Регион магазина
[apiInstance getCampaignRegionWith:campaignId
              completionHandler: ^(GetCampaignRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignRegion(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignRegionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Регион магазина
                GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignRegion($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignRegion(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Регион магазина
    api_response = api_instance.get_campaign_region(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignRegion: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignRegion(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignSettings

Настройки магазина

Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/settings

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignSettings(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignSettings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки магазина
[apiInstance getCampaignSettingsWith:campaignId
              completionHandler: ^(GetCampaignSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignSettings(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки магазина
                GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignSettings($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignSettings(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки магазина
    api_response = api_instance.get_campaign_settings(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignSettings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignSettings(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaigns

Список магазинов пользователя

Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaigns(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaigns: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Список магазинов пользователя
[apiInstance getCampaignsWith:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaigns(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Список магазинов пользователя
                GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaigns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaigns($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaigns(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Список магазинов пользователя
    api_response = api_instance.get_campaigns(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaigns: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaigns(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCampaignsByLogin

Магазины, доступные логину

Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/by_login/{login}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/by_login/{login}?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String login = new String(); // String | Логин пользователя.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaignsByLogin(login, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignsByLogin: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
String *login = login_example; // Логин пользователя. (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Магазины, доступные логину
[apiInstance getCampaignsByLoginWith:login
    page:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var login = login_example; // {String} Логин пользователя.
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignsByLogin(login, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsByLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var login = login_example;  // String | Логин пользователя. (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Магазины, доступные логину
                GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCampaignsByLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$login = login_example; // String | Логин пользователя.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaignsByLogin($login, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCampaignsByLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $login = login_example; # String | Логин пользователя.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaignsByLogin(login => $login, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCampaignsByLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
login = login_example # String | Логин пользователя. (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Магазины, доступные логину
    api_response = api_instance.get_campaigns_by_login(login, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCampaignsByLogin: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let login = login_example; // String
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getCampaignsByLogin(login, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
login*
String
Логин пользователя.
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCategoriesMaxSaleQuantum

Лимит на установку кванта продажи и минимального количества товаров в заказе

Возвращает лимит на установку [кванта](*quantum) и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий. Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины. Подробнее о том, как продавать товары по несколько штук, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/fields/quantum). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/max-sale-quantum

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/max-sale-quantum" \
 -d '{
  "marketCategoryIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

try {
    final result = await api_instance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesMaxSaleQuantum: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GetCategoriesMaxSaleQuantumRequest *getCategoriesMaxSaleQuantumRequest = ; // 

// Лимит на установку кванта продажи и минимального количества товаров в заказе
[apiInstance getCategoriesMaxSaleQuantumWith:getCategoriesMaxSaleQuantumRequest
              completionHandler: ^(GetCategoriesMaxSaleQuantumResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var getCategoriesMaxSaleQuantumRequest = ; // {GetCategoriesMaxSaleQuantumRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesMaxSaleQuantumExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

            try {
                // Лимит на установку кванта продажи и минимального количества товаров в заказе
                GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCategoriesMaxSaleQuantum: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

try {
    $result = $api_instance->getCategoriesMaxSaleQuantum($getCategoriesMaxSaleQuantumRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCategoriesMaxSaleQuantum: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $getCategoriesMaxSaleQuantumRequest = WWW::OPenAPIClient::Object::GetCategoriesMaxSaleQuantumRequest->new(); # GetCategoriesMaxSaleQuantumRequest | 

eval {
    my $result = $api_instance->getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest => $getCategoriesMaxSaleQuantumRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCategoriesMaxSaleQuantum: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
getCategoriesMaxSaleQuantumRequest =  # GetCategoriesMaxSaleQuantumRequest | 

try:
    # Лимит на установку кванта продажи и минимального количества товаров в заказе
    api_response = api_instance.get_categories_max_sale_quantum(getCategoriesMaxSaleQuantumRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCategoriesMaxSaleQuantum: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesMaxSaleQuantumRequest *

Responses


getCategoriesTree

Дерево категорий

Возвращает дерево категорий Маркета. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/tree

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/tree" \
 -d '{
  "language" : "RU"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesRequest getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest | 

try {
    final result = await api_instance.getCategoriesTree(getCategoriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesTree: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
GetCategoriesRequest *getCategoriesRequest = ; //  (optional)

// Дерево категорий
[apiInstance getCategoriesTreeWith:getCategoriesRequest
              completionHandler: ^(GetCategoriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var opts = {
  'getCategoriesRequest':  // {GetCategoriesRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesTree(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesTreeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest |  (optional) 

            try {
                // Дерево категорий
                GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCategoriesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$getCategoriesRequest = ; // GetCategoriesRequest | 

try {
    $result = $api_instance->getCategoriesTree($getCategoriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCategoriesTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $getCategoriesRequest = WWW::OPenAPIClient::Object::GetCategoriesRequest->new(); # GetCategoriesRequest | 

eval {
    my $result = $api_instance->getCategoriesTree(getCategoriesRequest => $getCategoriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCategoriesTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
getCategoriesRequest =  # GetCategoriesRequest |  (optional)

try:
    # Дерево категорий
    api_response = api_instance.get_categories_tree(getCategoriesRequest=getCategoriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCategoriesTree: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let getCategoriesRequest = ; // GetCategoriesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getCategoriesTree(getCategoriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesRequest

Responses


getCategoryContentParameters

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |**⚙️ Лимит:** 50 категорий в минуту | |-|


/category/{categoryId}/parameters

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/category/{categoryId}/parameters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long categoryId = new Long(); // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    final result = await api_instance.getCategoryContentParameters(categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryContentParameters: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *categoryId = 789; // Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

// Списки характеристик товаров по категориям
[apiInstance getCategoryContentParametersWith:categoryId
              completionHandler: ^(GetCategoryContentParametersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var categoryId = 789; // {Long} Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryContentParameters(categoryId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoryContentParametersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var categoryId = 789;  // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

            try {
                // Списки характеристик товаров по категориям
                GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getCategoryContentParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    $result = $api_instance->getCategoryContentParameters($categoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getCategoryContentParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $categoryId = 789; # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


eval {
    my $result = $api_instance->getCategoryContentParameters(categoryId => $categoryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getCategoryContentParameters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
categoryId = 789 # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

try:
    # Списки характеристик товаров по категориям
    api_response = api_instance.get_category_content_parameters(categoryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getCategoryContentParameters: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let categoryId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getCategoryContentParameters(categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
categoryId*
Long (int64)
Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
Required

Responses


getChatHistory

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history?chatId=789&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "messageIdFrom" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final GetChatHistoryRequest getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChatHistory: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
GetChatHistoryRequest *getChatHistoryRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение истории сообщений в чате
[apiInstance getChatHistoryWith:businessId
    chatId:chatId
    getChatHistoryRequest:getChatHistoryRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatHistoryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var getChatHistoryRequest = ; // {GetChatHistoryRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatHistory(businessId, chatId, getChatHistoryRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatHistoryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение истории сообщений в чате
                GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getChatHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$getChatHistoryRequest = ; // GetChatHistoryRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChatHistory($businessId, $chatId, $getChatHistoryRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $getChatHistoryRequest = WWW::OPenAPIClient::Object::GetChatHistoryRequest->new(); # GetChatHistoryRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChatHistory(businessId => $businessId, chatId => $chatId, getChatHistoryRequest => $getChatHistoryRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getChatHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
getChatHistoryRequest =  # GetChatHistoryRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение истории сообщений в чате
    api_response = api_instance.get_chat_history(businessId, chatId, getChatHistoryRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getChatHistory: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let getChatHistoryRequest = ; // GetChatHistoryRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatHistoryRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getChats

Получение доступных чатов

Возвращает ваши чаты с покупателями. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "types" : [ "CHAT", "CHAT" ],
  "statuses" : [ "NEW", "NEW" ],
  "orderIds" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getChats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetChatsRequest getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChats(businessId, getChatsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChats: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getChats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetChatsRequest *getChatsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение доступных чатов
[apiInstance getChatsWith:businessId
    getChatsRequest:getChatsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getChatsRequest = ; // {GetChatsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChats(businessId, getChatsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение доступных чатов
                GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getChatsRequest = ; // GetChatsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChats($businessId, $getChatsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getChatsRequest = WWW::OPenAPIClient::Object::GetChatsRequest->new(); # GetChatsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChats(businessId => $businessId, getChatsRequest => $getChatsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getChatsRequest =  # GetChatsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение доступных чатов
    api_response = api_instance.get_chats(businessId, getChatsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getChats: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getChatsRequest = ; // GetChatsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getChats(businessId, getChatsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatsRequest *

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getDeliveryServices

Справочник служб доставки

Возвращает справочник служб доставки: идентификаторы и наименования. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/delivery/services

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/delivery/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDeliveryServices();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDeliveryServices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];

// Справочник служб доставки
[apiInstance getDeliveryServicesWithCompletionHandler: 
              ^(GetDeliveryServicesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryServices(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getDeliveryServicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();

            try {
                // Справочник служб доставки
                GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getDeliveryServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();

try {
    $result = $api_instance->getDeliveryServices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getDeliveryServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();

eval {
    my $result = $api_instance->getDeliveryServices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getDeliveryServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()

try:
    # Справочник служб доставки
    api_response = api_instance.get_delivery_services()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getDeliveryServices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {

    let mut context = ExpressApi::Context::default();
    let result = client.getDeliveryServices(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


getFeed

Информация о прайс-листе

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.getFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeed: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Информация о прайс-листе
[apiInstance getFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(GetFeedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Информация о прайс-листе
                GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->getFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->getFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Информация о прайс-листе
    api_response = api_instance.get_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getFeed: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


getFeedIndexLogs

Отчет по индексации прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра `generationId`. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}/index-logs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs?limit=20&published_time_from=2013-10-20T19:20:30+01:00&published_time_to=2013-10-20T19:20:30+01:00&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Date publishedTimeFrom = new Date(); // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

final Date publishedTimeTo = new Date(); // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

final FeedIndexLogsStatusType status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    final result = await api_instance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedIndexLogs: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Date *publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
Date *publishedTimeTo = 2013-10-20T19:20:30+01:00; // Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
FeedIndexLogsStatusType *status = ; // Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

// Отчет по индексации прайс-листа
[apiInstance getFeedIndexLogsWith:campaignId
    feedId:feedId
    limit:limit
    publishedTimeFrom:publishedTimeFrom
    publishedTimeTo:publishedTimeTo
    status:status
              completionHandler: ^(GetFeedIndexLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var opts = {
  'limit': 20, // {Integer} Количество значений на одной странице.

  'publishedTimeFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

  'publishedTimeTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

  'status':  // {FeedIndexLogsStatusType} Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedIndexLogs(campaignId, feedId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedIndexLogsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var publishedTimeFrom = 2013-10-20T19:20:30+01:00;  // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional)  (default to null)
            var publishedTimeTo = 2013-10-20T19:20:30+01:00;  // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional)  (default to null)
            var status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional)  (default to null)

            try {
                // Отчет по индексации прайс-листа
                GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getFeedIndexLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$limit = 20; // Integer | Количество значений на одной странице.

$publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

$publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

$status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    $result = $api_instance->getFeedIndexLogs($campaignId, $feedId, $limit, $publishedTimeFrom, $publishedTimeTo, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $limit = 20; # Integer | Количество значений на одной странице.

my $publishedTimeFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

my $publishedTimeTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

my $status = ; # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


eval {
    my $result = $api_instance->getFeedIndexLogs(campaignId => $campaignId, feedId => $feedId, limit => $limit, publishedTimeFrom => $publishedTimeFrom, publishedTimeTo => $publishedTimeTo, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getFeedIndexLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
publishedTimeFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
publishedTimeTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
status =  # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

try:
    # Отчет по индексации прайс-листа
    api_response = api_instance.get_feed_index_logs(campaignId, feedId, limit=limit, publishedTimeFrom=publishedTimeFrom, publishedTimeTo=publishedTimeTo, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getFeedIndexLogs: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let limit = 20; // Integer
    let publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date
    let publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date
    let status = ; // FeedIndexLogsStatusType

    let mut context = ExpressApi::Context::default();
    let result = client.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Query parameters
Name Description
limit
Integer (int32)
Количество значений на одной странице.
published_time_from
Date (date-time)
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.
published_time_to
Date (date-time)
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}
status
FeedIndexLogsStatusType
Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

Responses


getFeedbackAndCommentUpdates

Новые и обновленные отзывы о магазине

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает новые и обновленные отзывы о магазине на Маркете. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/feedback/updates

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feedback/updates?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&from_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final date fromDate = new date(); // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    final result = await api_instance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedbackAndCommentUpdates: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
date *fromDate = 2013-10-20; // Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

// Новые и обновленные отзывы о магазине
[apiInstance getFeedbackAndCommentUpdatesWith:campaignId
    pageToken:pageToken
    limit:limit
    fromDate:fromDate
              completionHandler: ^(GetFeedbackListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'fromDate': 2013-10-20 // {date} Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedbackAndCommentUpdates(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedbackAndCommentUpdatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var fromDate = 2013-10-20;  // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)

            try {
                // Новые и обновленные отзывы о магазине
                GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getFeedbackAndCommentUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    $result = $api_instance->getFeedbackAndCommentUpdates($campaignId, $pageToken, $limit, $fromDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getFeedbackAndCommentUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $fromDate = 2013-10-20; # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


eval {
    my $result = $api_instance->getFeedbackAndCommentUpdates(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, fromDate => $fromDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getFeedbackAndCommentUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
fromDate = 2013-10-20 # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

try:
    # Новые и обновленные отзывы о магазине
    api_response = api_instance.get_feedback_and_comment_updates(campaignId, pageToken=pageToken, limit=limit, fromDate=fromDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getFeedbackAndCommentUpdates: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let fromDate = 2013-10-20; // date

    let mut context = ExpressApi::Context::default();
    let result = client.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
from_date
date (date)
Начальная дата обновления отзывов. Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты. Формат даты: `ГГГГ-ММ-ДД`.

Responses


getFeeds

Список прайс-листов магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeeds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getFeeds(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeeds: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список прайс-листов магазина
[apiInstance getFeedsWith:campaignId
              completionHandler: ^(GetFeedsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список прайс-листов магазина
                GetFeedsResponse result = apiInstance.getFeeds(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getFeeds($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getFeeds(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getFeeds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список прайс-листов магазина
    api_response = api_instance.get_feeds(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getFeeds: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getFeeds(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getGoodsFeedbackComments

Получение комментариев к отзыву

Возвращает комментарии к отзыву. Результаты возвращаются постранично, одна страница содержит не более 20 комментариев. Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "feedbackId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbackComments: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsFeedbackCommentsRequest *getGoodsFeedbackCommentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение комментариев к отзыву
[apiInstance getGoodsFeedbackCommentsWith:businessId
    getGoodsFeedbackCommentsRequest:getGoodsFeedbackCommentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetGoodsFeedbackCommentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsFeedbackCommentsRequest = ; // {GetGoodsFeedbackCommentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbackCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение комментариев к отзыву
                GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getGoodsFeedbackComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getGoodsFeedbackComments($businessId, $getGoodsFeedbackCommentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getGoodsFeedbackComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsFeedbackCommentsRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackCommentsRequest->new(); # GetGoodsFeedbackCommentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getGoodsFeedbackComments(businessId => $businessId, getGoodsFeedbackCommentsRequest => $getGoodsFeedbackCommentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getGoodsFeedbackComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsFeedbackCommentsRequest =  # GetGoodsFeedbackCommentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение комментариев к отзыву
    api_response = api_instance.get_goods_feedback_comments(businessId, getGoodsFeedbackCommentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getGoodsFeedbackComments: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackCommentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsFeedbacks

Получение отзывов о товарах продавца

Возвращает все отзывы о товарах продавца по указанным фильтрам. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "ratingValues" : [ 0, 0, 0, 0, 0 ],
  "modelIds" : [ 6, 6, 6, 6, 6 ],
  "paid" : true,
  "reactionStatus" : "ALL",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetGoodsFeedbackRequest getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest | 

try {
    final result = await api_instance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbacks: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetGoodsFeedbackRequest *getGoodsFeedbackRequest = ; //  (optional)

// Получение отзывов о товарах продавца
[apiInstance getGoodsFeedbacksWith:businessId
    pageToken:pageToken
    limit:limit
    getGoodsFeedbackRequest:getGoodsFeedbackRequest
              completionHandler: ^(GetGoodsFeedbackResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getGoodsFeedbackRequest':  // {GetGoodsFeedbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbacks(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest |  (optional) 

            try {
                // Получение отзывов о товарах продавца
                GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getGoodsFeedbacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

try {
    $result = $api_instance->getGoodsFeedbacks($businessId, $pageToken, $limit, $getGoodsFeedbackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getGoodsFeedbacks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackRequest->new(); # GetGoodsFeedbackRequest | 

eval {
    my $result = $api_instance->getGoodsFeedbacks(businessId => $businessId, pageToken => $pageToken, limit => $limit, getGoodsFeedbackRequest => $getGoodsFeedbackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getGoodsFeedbacks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getGoodsFeedbackRequest =  # GetGoodsFeedbackRequest |  (optional)

try:
    # Получение отзывов о товарах продавца
    api_response = api_instance.get_goods_feedbacks(businessId, pageToken=pageToken, limit=limit, getGoodsFeedbackRequest=getGoodsFeedbackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getGoodsFeedbacks: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsStats

Отчет по товарам

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/stats/skus

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/skus" \
 -d '{
  "shopSkus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsStatsRequest getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

try {
    final result = await api_instance.getGoodsStats(campaignId, getGoodsStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsStats: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsStatsRequest *getGoodsStatsRequest = ; // 

// Отчет по товарам
[apiInstance getGoodsStatsWith:campaignId
    getGoodsStatsRequest:getGoodsStatsRequest
              completionHandler: ^(GetGoodsStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsStatsRequest = ; // {GetGoodsStatsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsStats(campaignId, getGoodsStatsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

            try {
                // Отчет по товарам
                GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getGoodsStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

try {
    $result = $api_instance->getGoodsStats($campaignId, $getGoodsStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getGoodsStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsStatsRequest = WWW::OPenAPIClient::Object::GetGoodsStatsRequest->new(); # GetGoodsStatsRequest | 

eval {
    my $result = $api_instance->getGoodsStats(campaignId => $campaignId, getGoodsStatsRequest => $getGoodsStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getGoodsStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsStatsRequest =  # GetGoodsStatsRequest | 

try:
    # Отчет по товарам
    api_response = api_instance.get_goods_stats(campaignId, getGoodsStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getGoodsStats: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let getGoodsStatsRequest = ; // GetGoodsStatsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getGoodsStats(campaignId, getGoodsStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsStatsRequest *

Responses


getHiddenOffers

Информация о скрытых вами товарах

Возвращает список скрытых вами товаров для заданного магазина. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers?offer_id=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&offset=56&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Integer offset = new Integer(); // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHiddenOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор скрытого предложения.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Integer *offset = 56; // Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о скрытых вами товарах
[apiInstance getHiddenOffersWith:campaignId
    offerId:offerId
    pageToken:pageToken
    limit:limit
    offset:offset
    page:page
    pageSize:pageSize
              completionHandler: ^(GetHiddenOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор скрытого предложения.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'offset': 56, // {Integer} Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHiddenOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var offset = 56;  // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о скрытых вами товарах
                GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор скрытого предложения.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getHiddenOffers($campaignId, $offerId, $pageToken, $limit, $offset, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор скрытого предложения.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $offset = 56; # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getHiddenOffers(campaignId => $campaignId, offerId => $offerId, pageToken => $pageToken, limit => $limit, offset => $offset, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор скрытого предложения.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
offset = 56 # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о скрытых вами товарах
    api_response = api_instance.get_hidden_offers(campaignId, offerId=offerId, pageToken=pageToken, limit=limit, offset=offset, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getHiddenOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let offset = 56; // Integer
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор скрытого предложения.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
offset
Integer (int32)
Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOfferCardsContentStatus

Получение информации о заполненности карточек магазина

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * переданные характеристики товаров; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |**⚙️ Лимит:** 600 запросов в минуту| |-|


/businesses/{businessId}/offer-cards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ null, null, null, null, null ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest | 

try {
    final result = await api_instance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferCardsContentStatus: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferCardsContentStatusRequest *getOfferCardsContentStatusRequest = ; //  (optional)

// Получение информации о заполненности карточек магазина
[apiInstance getOfferCardsContentStatusWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferCardsContentStatusRequest:getOfferCardsContentStatusRequest
              completionHandler: ^(GetOfferCardsContentStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferCardsContentStatusRequest':  // {GetOfferCardsContentStatusRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferCardsContentStatus(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferCardsContentStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest |  (optional) 

            try {
                // Получение информации о заполненности карточек магазина
                GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOfferCardsContentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

try {
    $result = $api_instance->getOfferCardsContentStatus($businessId, $pageToken, $limit, $getOfferCardsContentStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOfferCardsContentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferCardsContentStatusRequest = WWW::OPenAPIClient::Object::GetOfferCardsContentStatusRequest->new(); # GetOfferCardsContentStatusRequest | 

eval {
    my $result = $api_instance->getOfferCardsContentStatus(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferCardsContentStatusRequest => $getOfferCardsContentStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOfferCardsContentStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferCardsContentStatusRequest =  # GetOfferCardsContentStatusRequest |  (optional)

try:
    # Получение информации о заполненности карточек магазина
    api_response = api_instance.get_offer_cards_content_status(businessId, pageToken=pageToken, limit=limit, getOfferCardsContentStatusRequest=getOfferCardsContentStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOfferCardsContentStatus: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferCardsContentStatusRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappingEntries

Список товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров в каталоге магазина * 25)


/campaigns/{campaignId}/offer-mapping-entries

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries?offer_id=&shop_sku=&mapping_kind=&status=&availability=&category_id=&vendor=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор товара в каталоге.
final array[String] shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final OfferMappingKindType mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
final array[OfferProcessingStatusType] status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final array[OfferAvailabilityStatusType] availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[Integer] categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[String] vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор товара в каталоге. (optional) (default to null)
array[String] *shopSku = ; // Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
OfferMappingKindType *mappingKind = ; // Тип маппинга. (optional) (default to null)
array[OfferProcessingStatusType] *status = ; // Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[OfferAvailabilityStatusType] *availability = ; // Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[Integer] *categoryId = ; // Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[String] *vendor = ; // Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров в каталоге
[apiInstance getOfferMappingEntriesWith:campaignId
    offerId:offerId
    shopSku:shopSku
    mappingKind:mappingKind
    status:status
    availability:availability
    categoryId:categoryId
    vendor:vendor
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор товара в каталоге.
  'shopSku': , // {array[String]} Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'mappingKind': , // {OfferMappingKindType} Тип маппинга.
  'status': , // {array[OfferProcessingStatusType]} Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'availability': , // {array[OfferAvailabilityStatusType]} Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'categoryId': , // {array[Integer]} Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'vendor': , // {array[String]} Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappingEntries(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор товара в каталоге. (optional)  (default to null)
            var shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга. (optional)  (default to null)
            var status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров в каталоге
                GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор товара в каталоге.
$shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$mappingKind = ; // OfferMappingKindType | Тип маппинга.
$status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferMappingEntries($campaignId, $offerId, $shopSku, $mappingKind, $status, $availability, $categoryId, $vendor, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор товара в каталоге.
my $shopSku = []; # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $mappingKind = ; # OfferMappingKindType | Тип маппинга.
my $status = []; # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $availability = []; # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $categoryId = []; # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $vendor = []; # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferMappingEntries(campaignId => $campaignId, offerId => $offerId, shopSku => $shopSku, mappingKind => $mappingKind, status => $status, availability => $availability, categoryId => $categoryId, vendor => $vendor, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор товара в каталоге. (optional) (default to null)
shopSku =  # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
mappingKind =  # OfferMappingKindType | Тип маппинга. (optional) (default to null)
status =  # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
availability =  # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
categoryId =  # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
vendor =  # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров в каталоге
    api_response = api_instance.get_offer_mapping_entries(campaignId, offerId=offerId, shopSku=shopSku, mappingKind=mappingKind, status=status, availability=availability, categoryId=categoryId, vendor=vendor, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOfferMappingEntries: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let shopSku = ; // array[String]
    let mappingKind = ; // OfferMappingKindType
    let status = ; // array[OfferProcessingStatusType]
    let availability = ; // array[OfferAvailabilityStatusType]
    let categoryId = ; // array[Integer]
    let vendor = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор товара в каталоге.
shop_sku
array[String]
Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
mapping_kind
OfferMappingKindType
Тип маппинга.
status
array[OfferProcessingStatusType]
Фильтрация по статусу публикации товара: * `READY` — товар прошел модерацию. * `IN_WORK` — товар проходит модерацию. * `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * `OTHER` — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
availability
array[OfferAvailabilityStatusType]
Фильтрация по планам поставок товара: * `ACTIVE` — поставки будут. * `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
category_id
array[Integer]
Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md). Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
vendor
array[String]
Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL). В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappings

Информация о товарах в каталоге

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара. Можно использовать тремя способами: * задать список интересующих SKU; * задать фильтр — в этом случае результаты возвращаются постранично; * не передавать тело запроса, чтобы получить список всех товаров в каталоге. |**⚙️ Лимит:** 600 запросов в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferMappingsRequest getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest | 

try {
    final result = await api_instance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferMappingsRequest *getOfferMappingsRequest = ; //  (optional)

// Информация о товарах в каталоге
[apiInstance getOfferMappingsWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferMappingsRequest:getOfferMappingsRequest
              completionHandler: ^(GetOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferMappingsRequest':  // {GetOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest |  (optional) 

            try {
                // Информация о товарах в каталоге
                GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

try {
    $result = $api_instance->getOfferMappings($businessId, $pageToken, $limit, $getOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferMappingsRequest = WWW::OPenAPIClient::Object::GetOfferMappingsRequest->new(); # GetOfferMappingsRequest | 

eval {
    my $result = $api_instance->getOfferMappings(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferMappingsRequest => $getOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferMappingsRequest =  # GetOfferMappingsRequest |  (optional)

try:
    # Информация о товарах в каталоге
    api_response = api_instance.get_offer_mappings(businessId, pageToken=pageToken, limit=limit, getOfferMappingsRequest=getOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOfferMappings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferMappingsRequest = ; // GetOfferMappingsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferMappingsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferRecommendations

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. **1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.** Показывает, какие **цены для участия** нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#sponsored-discounts) **2. Оценка привлекательности цен на витрине.** Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#validation) В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/offers/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cofinancePriceFilter" : "SPECIFIED",
  "competitivenessFilter" : "OPTIMAL",
  "offerIds" : [ null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetOfferRecommendationsRequest getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferRecommendations: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetOfferRecommendationsRequest *getOfferRecommendationsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Рекомендации Маркета, касающиеся цен
[apiInstance getOfferRecommendationsWith:businessId
    getOfferRecommendationsRequest:getOfferRecommendationsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getOfferRecommendationsRequest = ; // {GetOfferRecommendationsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferRecommendations(businessId, getOfferRecommendationsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Рекомендации Маркета, касающиеся цен
                GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOfferRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferRecommendations($businessId, $getOfferRecommendationsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getOfferRecommendationsRequest = WWW::OPenAPIClient::Object::GetOfferRecommendationsRequest->new(); # GetOfferRecommendationsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferRecommendations(businessId => $businessId, getOfferRecommendationsRequest => $getOfferRecommendationsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOfferRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getOfferRecommendationsRequest =  # GetOfferRecommendationsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Рекомендации Маркета, касающиеся цен
    api_response = api_instance.get_offer_recommendations(businessId, getOfferRecommendationsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOfferRecommendations: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferRecommendationsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOffers

Предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?query=query_example&feedId=789&shopCategoryId=shopCategoryId_example¤cy=&matched=true&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String query = new String(); // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final String shopCategoryId = new String(); // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

final Boolean matched = new Boolean(); // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *query = query_example; // Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
String *shopCategoryId = shopCategoryId_example; // Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
CurrencyType *currency = ; // Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
Boolean *matched = true; // Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Предложения магазина
[apiInstance getOffersWith:campaignId
    query:query
    feedId:feedId
    shopCategoryId:shopCategoryId
    currency:currency
    matched:matched
    page:page
    pageSize:pageSize
              completionHandler: ^(GetOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'query': query_example, // {String} Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'shopCategoryId': shopCategoryId_example, // {String} Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

  'currency': , // {CurrencyType} Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

  'matched': true, // {Boolean} Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var query = query_example;  // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional)  (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var shopCategoryId = shopCategoryId_example;  // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional)  (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional)  (default to null)
            var matched = true;  // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Предложения магазина
                GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

$feedId = 789; // Long | Идентификатор прайс-листа.
$shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

$currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

$matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getOffers($campaignId, $query, $feedId, $shopCategoryId, $currency, $matched, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $query = query_example; # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $shopCategoryId = shopCategoryId_example; # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

my $currency = ; # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

my $matched = true; # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getOffers(campaignId => $campaignId, query => $query, feedId => $feedId, shopCategoryId => $shopCategoryId, currency => $currency, matched => $matched, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
query = query_example # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
shopCategoryId = shopCategoryId_example # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
currency =  # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
matched = true # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Предложения магазина
    api_response = api_instance.get_offers(campaignId, query=query, feedId=feedId, shopCategoryId=shopCategoryId, currency=currency, matched=matched, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let query = query_example; // String
    let feedId = 789; // Long
    let shopCategoryId = shopCategoryId_example; // String
    let currency = ; // CurrencyType
    let matched = true; // Boolean
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
query
String
Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId
Long (int64)
Идентификатор прайс-листа.
shopCategoryId
String
Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency
CurrencyType
Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.
matched
Boolean
Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOrder

Информация об одном заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrder");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrder(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrder: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация об одном заказе
[apiInstance getOrderWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация об одном заказе
                GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrder($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrder(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация об одном заказе
    api_response = api_instance.get_order(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOrder: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getOrder(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessBuyerInfo

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY`, `PICKUP` или `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/business-buyer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/business-buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessBuyerInfo: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — юридическом лице
[apiInstance getOrderBusinessBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — юридическом лице
                GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOrderBusinessBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOrderBusinessBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — юридическом лице
    api_response = api_instance.get_order_business_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOrderBusinessBuyerInfo: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getOrderBusinessBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessDocumentsInfo

Информация о документах

Возвращает информацию о документах по идентификатору заказа. Получить данные можно после того, как заказ перейдет в статус `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/documents

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessDocumentsInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessDocumentsInfo: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о документах
[apiInstance getOrderBusinessDocumentsInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessDocumentsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessDocumentsInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessDocumentsInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о документах
                GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOrderBusinessDocumentsInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessDocumentsInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessDocumentsInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOrderBusinessDocumentsInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о документах
    api_response = api_instance.get_order_business_documents_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOrderBusinessDocumentsInfo: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getOrderBusinessDocumentsInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderLabelsData

Данные для самостоятельного изготовления ярлыков

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderLabelsData(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderLabelsData: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Данные для самостоятельного изготовления ярлыков
[apiInstance getOrderLabelsDataWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderLabelsDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderLabelsData(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderLabelsDataExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Данные для самостоятельного изготовления ярлыков
                GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOrderLabelsData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderLabelsData($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOrderLabelsData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderLabelsData(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOrderLabelsData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Данные для самостоятельного изготовления ярлыков
    api_response = api_instance.get_order_labels_data(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOrderLabelsData: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getOrderLabelsData(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrders

Информация о нескольких заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * идентификаторам заказов; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) (если у вас есть идентификатор заказа) или запроса отчета по заказам [POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md). Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Для навигации по страницам используйте параметры `page_token` и `limit`. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders?orderIds=&status=&substatus=&fromDate=2013-10-20&toDate=2013-10-20&supplierShipmentDateFrom=2013-10-20&supplierShipmentDateTo=2013-10-20&updatedAtFrom=2013-10-20T19:20:30+01:00&updatedAtTo=2013-10-20T19:20:30+01:00&dispatchType=&fake=true&hasCis=true&onlyWaitingForCancellationApprove=true&onlyEstimatedDelivery=true&buyerType=&page=56&pageSize=56&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExpressApi#getOrders"); e.printStackTrace(); } } }
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[Long] orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. final set[OrderStatusType] status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. final set[OrderSubstatusType] substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. final date fromDate = new date(); // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. final date toDate = new date(); // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. final date supplierShipmentDateFrom = new date(); // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final date supplierShipmentDateTo = new date(); // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final Date updatedAtFrom = new Date(); // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final Date updatedAtTo = new Date(); // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final OrderDeliveryDispatchType dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки final Boolean fake = new Boolean(); // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. final Boolean hasCis = new Boolean(); // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. final Boolean onlyWaitingForCancellationApprove = new Boolean(); // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). final Boolean onlyEstimatedDelivery = new Boolean(); // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. final OrderBuyerType buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. final Integer page = new Integer(); // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. final Integer pageSize = new Integer(); // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. final String pageToken = new String(); // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. final Integer limit = new Integer(); // Integer | Количество значений на одной странице. try { final result = await api_instance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); print(result); } catch (e) { print('Exception when calling DefaultApi->getOrders: $e\n'); }
import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExpressApi#getOrders"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[Long] *orderIds = ; // Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) set[OrderStatusType] *status = ; // Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) set[OrderSubstatusType] *substatus = ; // Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) date *fromDate = 2013-10-20; // Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) date *toDate = 2013-10-20; // Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) date *supplierShipmentDateFrom = 2013-10-20; // Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) date *supplierShipmentDateTo = 2013-10-20; // Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtFrom = 2013-10-20T19:20:30+01:00; // Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtTo = 2013-10-20T19:20:30+01:00; // Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) OrderDeliveryDispatchType *dispatchType = ; // Способ отгрузки (optional) (default to null) Boolean *fake = true; // Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) Boolean *hasCis = true; // Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) Boolean *onlyWaitingForCancellationApprove = true; // **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) Boolean *onlyEstimatedDelivery = true; // Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) OrderBuyerType *buyerType = ; // Фильтрация заказов по типу покупателя. (optional) (default to null) Integer *page = 56; // Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) Integer *pageSize = 56; // Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) Integer *limit = 20; // Количество значений на одной странице. (optional) (default to null) // Информация о нескольких заказах [apiInstance getOrdersWith:campaignId orderIds:orderIds status:status substatus:substatus fromDate:fromDate toDate:toDate supplierShipmentDateFrom:supplierShipmentDateFrom supplierShipmentDateTo:supplierShipmentDateTo updatedAtFrom:updatedAtFrom updatedAtTo:updatedAtTo dispatchType:dispatchType fake:fake hasCis:hasCis onlyWaitingForCancellationApprove:onlyWaitingForCancellationApprove onlyEstimatedDelivery:onlyEstimatedDelivery buyerType:buyerType page:page pageSize:pageSize pageToken:pageToken limit:limit completionHandler: ^(GetOrdersResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'orderIds': , // {array[Long]} Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. 'status': , // {set[OrderStatusType]} Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. 'substatus': , // {set[OrderSubstatusType]} Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. 'fromDate': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. 'toDate': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. 'supplierShipmentDateFrom': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'supplierShipmentDateTo': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'updatedAtFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'updatedAtTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'dispatchType': , // {OrderDeliveryDispatchType} Способ отгрузки 'fake': true, // {Boolean} Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. 'hasCis': true, // {Boolean} Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. 'onlyWaitingForCancellationApprove': true, // {Boolean} **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). 'onlyEstimatedDelivery': true, // {Boolean} Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. 'buyerType': , // {OrderBuyerType} Фильтрация заказов по типу покупателя. 'page': 56, // {Integer} Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageSize': 56, // {Integer} Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. 'limit': 20 // {Integer} Количество значений на одной странице. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getOrders(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) var status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) var toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) var supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) var fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) var hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) var onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) var onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) var buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) var page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) var pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) var limit = 20; // Integer | Количество значений на одной странице. (optional) (default to null) try { // Информация о нескольких заказах GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ExpressApi.getOrders: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. $status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. $substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. $fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. $toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. $supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки $fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. $hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. $onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). $onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. $buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. $page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. $pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. $limit = 20; // Integer | Количество значений на одной странице. try { $result = $api_instance->getOrders($campaignId, $orderIds, $status, $substatus, $fromDate, $toDate, $supplierShipmentDateFrom, $supplierShipmentDateTo, $updatedAtFrom, $updatedAtTo, $dispatchType, $fake, $hasCis, $onlyWaitingForCancellationApprove, $onlyEstimatedDelivery, $buyerType, $page, $pageSize, $pageToken, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling ExpressApi->getOrders: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderIds = []; # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. my $status = []; # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. my $substatus = []; # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. my $fromDate = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. my $toDate = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. my $supplierShipmentDateFrom = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $supplierShipmentDateTo = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $updatedAtFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $updatedAtTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $dispatchType = ; # OrderDeliveryDispatchType | Способ отгрузки my $fake = true; # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. my $hasCis = true; # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. my $onlyWaitingForCancellationApprove = true; # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). my $onlyEstimatedDelivery = true; # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. my $buyerType = ; # OrderBuyerType | Фильтрация заказов по типу покупателя. my $page = 56; # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageSize = 56; # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. my $limit = 20; # Integer | Количество значений на одной странице. eval { my $result = $api_instance->getOrders(campaignId => $campaignId, orderIds => $orderIds, status => $status, substatus => $substatus, fromDate => $fromDate, toDate => $toDate, supplierShipmentDateFrom => $supplierShipmentDateFrom, supplierShipmentDateTo => $supplierShipmentDateTo, updatedAtFrom => $updatedAtFrom, updatedAtTo => $updatedAtTo, dispatchType => $dispatchType, fake => $fake, hasCis => $hasCis, onlyWaitingForCancellationApprove => $onlyWaitingForCancellationApprove, onlyEstimatedDelivery => $onlyEstimatedDelivery, buyerType => $buyerType, page => $page, pageSize => $pageSize, pageToken => $pageToken, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling ExpressApi->getOrders: $@\n"; }
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderIds =  # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) status = # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) substatus = # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) fromDate = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) toDate = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) supplierShipmentDateFrom = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) supplierShipmentDateTo = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) updatedAtFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) updatedAtTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) dispatchType = # OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) fake = true # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) hasCis = true # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) onlyWaitingForCancellationApprove = true # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) onlyEstimatedDelivery = true # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) buyerType = # OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) page = 56 # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) pageSize = 56 # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) limit = 20 # Integer | Количество значений на одной странице. (optional) (default to null) try: # Информация о нескольких заказах api_response = api_instance.get_orders(campaignId, orderIds=orderIds, status=status, substatus=substatus, fromDate=fromDate, toDate=toDate, supplierShipmentDateFrom=supplierShipmentDateFrom, supplierShipmentDateTo=supplierShipmentDateTo, updatedAtFrom=updatedAtFrom, updatedAtTo=updatedAtTo, dispatchType=dispatchType, fake=fake, hasCis=hasCis, onlyWaitingForCancellationApprove=onlyWaitingForCancellationApprove, onlyEstimatedDelivery=onlyEstimatedDelivery, buyerType=buyerType, page=page, pageSize=pageSize, pageToken=pageToken, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling ExpressApi->getOrders: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderIds = ; // array[Long]
    let status = ; // set[OrderStatusType]
    let substatus = ; // set[OrderSubstatusType]
    let fromDate = 2013-10-20; // date
    let toDate = 2013-10-20; // date
    let supplierShipmentDateFrom = 2013-10-20; // date
    let supplierShipmentDateTo = 2013-10-20; // date
    let updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date
    let updatedAtTo = 2013-10-20T19:20:30+01:00; // Date
    let dispatchType = ; // OrderDeliveryDispatchType
    let fake = true; // Boolean
    let hasCis = true; // Boolean
    let onlyWaitingForCancellationApprove = true; // Boolean
    let onlyEstimatedDelivery = true; // Boolean
    let buyerType = ; // OrderBuyerType
    let page = 56; // Integer
    let pageSize = 56; // Integer
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
orderIds
array[Long] (int64)
Фильтрация заказов по идентификаторам. <br><br> ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
status
set[OrderStatusType]
Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus
set[OrderSubstatusType]
Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.
fromDate
date (date)
Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
toDate
date (date)
Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.
supplierShipmentDateFrom
date (date)
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo
date (date)
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
updatedAtFrom
Date (date-time)
Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo
Date (date-time)
Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
dispatchType
OrderDeliveryDispatchType
Способ отгрузки
fake
Boolean
Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
hasCis
Boolean
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
onlyWaitingForCancellationApprove
Boolean
**Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
onlyEstimatedDelivery
Boolean
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
buyerType
OrderBuyerType
Фильтрация заказов по типу покупателя.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOrdersStats

Детальная информация по заказам

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п. {% note info "" %} Раньше генерация детальной информации по заказам называлась **Отчет по заказам**. Сейчас это новый отчет. [Подробнее об отчете](../../reference/reports/generateUnitedOrdersReport.md) {% endnote %} В одном запросе можно получить информацию не более чем по 200 заказам. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/stats/orders

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "updateTo" : "2000-01-23",
  "updateFrom" : "2000-01-23",
  "hasCis" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "CANCELLED_BEFORE_PROCESSING", "CANCELLED_BEFORE_PROCESSING" ],
  "orders" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOrdersStatsRequest getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest | 

try {
    final result = await api_instance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrdersStats: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOrdersStatsRequest *getOrdersStatsRequest = ; //  (optional)

// Детальная информация по заказам
[apiInstance getOrdersStatsWith:campaignId
    pageToken:pageToken
    limit:limit
    getOrdersStatsRequest:getOrdersStatsRequest
              completionHandler: ^(GetOrdersStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOrdersStatsRequest':  // {GetOrdersStatsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrdersStats(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest |  (optional) 

            try {
                // Детальная информация по заказам
                GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getOrdersStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

try {
    $result = $api_instance->getOrdersStats($campaignId, $pageToken, $limit, $getOrdersStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getOrdersStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOrdersStatsRequest = WWW::OPenAPIClient::Object::GetOrdersStatsRequest->new(); # GetOrdersStatsRequest | 

eval {
    my $result = $api_instance->getOrdersStats(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getOrdersStatsRequest => $getOrdersStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getOrdersStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOrdersStatsRequest =  # GetOrdersStatsRequest |  (optional)

try:
    # Детальная информация по заказам
    api_response = api_instance.get_orders_stats(campaignId, pageToken=pageToken, limit=limit, getOrdersStatsRequest=getOrdersStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getOrdersStats: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOrdersStatsRequest = ; // GetOrdersStatsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOrdersStatsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPrices

Список цен

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST campaigns/{campaignId}/offer-prices](../../reference/assortment/getPricesByOfferIds.md). {% endnote %} Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом. {% note info %} Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов. {% endnote %} Способы установки цен описаны [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/assortment/operations/prices.html). |**⚙️ Лимит:** ```(количество товаров партнера на витрине) * 25``` товаров в сутки| |-|


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&archived=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Boolean archived = new Boolean(); // Boolean | Фильтр по нахождению в архиве.

try {
    final result = await api_instance.getPrices(campaignId, pageToken, limit, archived);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Boolean *archived = true; // Фильтр по нахождению в архиве. (optional) (default to false)

// Список цен
[apiInstance getPricesWith:campaignId
    pageToken:pageToken
    limit:limit
    archived:archived
              completionHandler: ^(GetPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'archived': true // {Boolean} Фильтр по нахождению в архиве.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrices(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var archived = true;  // Boolean | Фильтр по нахождению в архиве. (optional)  (default to false)

            try {
                // Список цен
                GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$archived = true; // Boolean | Фильтр по нахождению в архиве.

try {
    $result = $api_instance->getPrices($campaignId, $pageToken, $limit, $archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $archived = true; # Boolean | Фильтр по нахождению в архиве.

eval {
    my $result = $api_instance->getPrices(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, archived => $archived);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
archived = true # Boolean | Фильтр по нахождению в архиве. (optional) (default to false)

try:
    # Список цен
    api_response = api_instance.get_prices(campaignId, pageToken=pageToken, limit=limit, archived=archived)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getPrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let archived = true; // Boolean

    let mut context = ExpressApi::Context::default();
    let result = client.getPrices(campaignId, pageToken, limit, archived, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
archived
Boolean
Фильтр по нахождению в архиве.

Responses


getPricesByOfferIds

Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине. {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для просмотра базовых цен используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров на витрине * 25)


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest | 

try {
    final result = await api_instance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPricesByOfferIds: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetPricesByOfferIdsRequest *getPricesByOfferIdsRequest = ; //  (optional)

// Просмотр цен на указанные товары в магазине
[apiInstance getPricesByOfferIdsWith:campaignId
    pageToken:pageToken
    limit:limit
    getPricesByOfferIdsRequest:getPricesByOfferIdsRequest
              completionHandler: ^(GetPricesByOfferIdsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getPricesByOfferIdsRequest':  // {GetPricesByOfferIdsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPricesByOfferIds(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesByOfferIdsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest |  (optional) 

            try {
                // Просмотр цен на указанные товары в магазине
                GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getPricesByOfferIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

try {
    $result = $api_instance->getPricesByOfferIds($campaignId, $pageToken, $limit, $getPricesByOfferIdsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getPricesByOfferIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getPricesByOfferIdsRequest = WWW::OPenAPIClient::Object::GetPricesByOfferIdsRequest->new(); # GetPricesByOfferIdsRequest | 

eval {
    my $result = $api_instance->getPricesByOfferIds(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getPricesByOfferIdsRequest => $getPricesByOfferIdsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getPricesByOfferIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getPricesByOfferIdsRequest =  # GetPricesByOfferIdsRequest |  (optional)

try:
    # Просмотр цен на указанные товары в магазине
    api_response = api_instance.get_prices_by_offer_ids(campaignId, pageToken=pageToken, limit=limit, getPricesByOfferIdsRequest=getPricesByOfferIdsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getPricesByOfferIds: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPricesByOfferIdsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromoOffers

Получение списка товаров, которые участвуют или могут участвовать в акции

Возвращает список товаров, которые участвуют или могут участвовать в акции. {% note warning %} В параметре `limit` не передавайте значение больше 500. {% endnote %} |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "statusType" : "MANUALLY_ADDED",
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromoOffersRequest getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromoOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromoOffersRequest *getPromoOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение списка товаров, которые участвуют или могут участвовать в акции
[apiInstance getPromoOffersWith:businessId
    getPromoOffersRequest:getPromoOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetPromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getPromoOffersRequest = ; // {GetPromoOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromoOffers(businessId, getPromoOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение списка товаров, которые участвуют или могут участвовать в акции
                GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getPromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromoOffersRequest = ; // GetPromoOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getPromoOffers($businessId, $getPromoOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getPromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromoOffersRequest = WWW::OPenAPIClient::Object::GetPromoOffersRequest->new(); # GetPromoOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getPromoOffers(businessId => $businessId, getPromoOffersRequest => $getPromoOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getPromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromoOffersRequest =  # GetPromoOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение списка товаров, которые участвуют или могут участвовать в акции
    api_response = api_instance.get_promo_offers(businessId, getPromoOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getPromoOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromoOffersRequest = ; // GetPromoOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromoOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromos

Получение списка акций

Возвращает информацию об акциях Маркета. По умолчанию возвращаются акции, в которых продавец участвует или может принять участие. Чтобы получить текущие или завершенные акции, передайте параметр `participation`. Типы акций, которые возвращаются в ответе: * прямая скидка; * флеш-акция; * скидка по промокоду. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/promos

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos" \
 -d '{
  "participation" : "PARTICIPATING_NOW",
  "mechanics" : "DIRECT_DISCOUNT"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPromos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromosRequest getPromosRequest = new GetPromosRequest(); // GetPromosRequest | 

try {
    final result = await api_instance.getPromos(businessId, getPromosRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromos: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getPromos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromosRequest *getPromosRequest = ; //  (optional)

// Получение списка акций
[apiInstance getPromosWith:businessId
    getPromosRequest:getPromosRequest
              completionHandler: ^(GetPromosResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getPromosRequest':  // {GetPromosRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromos(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromosExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromosRequest = new GetPromosRequest(); // GetPromosRequest |  (optional) 

            try {
                // Получение списка акций
                GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getPromos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromosRequest = ; // GetPromosRequest | 

try {
    $result = $api_instance->getPromos($businessId, $getPromosRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getPromos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromosRequest = WWW::OPenAPIClient::Object::GetPromosRequest->new(); # GetPromosRequest | 

eval {
    my $result = $api_instance->getPromos(businessId => $businessId, getPromosRequest => $getPromosRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getPromos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromosRequest =  # GetPromosRequest |  (optional)

try:
    # Получение списка акций
    api_response = api_instance.get_promos(businessId, getPromosRequest=getPromosRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getPromos: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromosRequest = ; // GetPromosRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getPromos(businessId, getPromosRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromosRequest

Responses


getQualityRatingDetails

Заказы, которые повлияли на индекс качества

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос [POST businesses/{businessId}/ratings/quality](../../reference/ratings/getQualityRatings.md). |**⚙️ Лимит:** 100000 запросов в час| |-|


/campaigns/{campaignId}/ratings/quality/details

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/ratings/quality/details"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getQualityRatingDetails(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatingDetails: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Заказы, которые повлияли на индекс качества
[apiInstance getQualityRatingDetailsWith:campaignId
              completionHandler: ^(GetQualityRatingDetailsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatingDetails(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Заказы, которые повлияли на индекс качества
                GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getQualityRatingDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getQualityRatingDetails($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getQualityRatingDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getQualityRatingDetails(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getQualityRatingDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Заказы, которые повлияли на индекс качества
    api_response = api_instance.get_quality_rating_details(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getQualityRatingDetails: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getQualityRatingDetails(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getQualityRatings

Индекс качества магазинов

Возвращает значение индекса качества магазинов и его составляющие. Подробнее об индексе качества читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/quality/score/). |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/ratings/quality

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality" \
 -d '{
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 0, 0, 0, 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQualityRatingRequest getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

try {
    final result = await api_instance.getQualityRatings(businessId, getQualityRatingRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQualityRatingRequest *getQualityRatingRequest = ; // 

// Индекс качества магазинов
[apiInstance getQualityRatingsWith:businessId
    getQualityRatingRequest:getQualityRatingRequest
              completionHandler: ^(GetQualityRatingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQualityRatingRequest = ; // {GetQualityRatingRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatings(businessId, getQualityRatingRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

            try {
                // Индекс качества магазинов
                GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getQualityRatings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQualityRatingRequest = ; // GetQualityRatingRequest | 

try {
    $result = $api_instance->getQualityRatings($businessId, $getQualityRatingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getQualityRatings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQualityRatingRequest = WWW::OPenAPIClient::Object::GetQualityRatingRequest->new(); # GetQualityRatingRequest | 

eval {
    my $result = $api_instance->getQualityRatings(businessId => $businessId, getQualityRatingRequest => $getQualityRatingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getQualityRatings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQualityRatingRequest =  # GetQualityRatingRequest | 

try:
    # Индекс качества магазинов
    api_response = api_instance.get_quality_ratings(businessId, getQualityRatingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getQualityRatings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getQualityRatingRequest = ; // GetQualityRatingRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getQualityRatings(businessId, getQualityRatingRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQualityRatingRequest *

Responses


getReportInfo

Получение заданного отчета

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. [Инструкция](../../step-by-step/reports.md) |**⚙️ Лимит:** 100 запросов в минуту| |-|


/reports/info/{reportId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/reports/info/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportId = new String(); // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    final result = await api_instance.getReportInfo(reportId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReportInfo: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
String *reportId = reportId_example; // Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

// Получение заданного отчета
[apiInstance getReportInfoWith:reportId
              completionHandler: ^(GetReportInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var reportId = reportId_example; // {String} Идентификатор отчета, который вы получили после запуска генерации.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportInfo(reportId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReportInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var reportId = reportId_example;  // String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

            try {
                // Получение заданного отчета
                GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getReportInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    $result = $api_instance->getReportInfo($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getReportInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $reportId = reportId_example; # String | Идентификатор отчета, который вы получили после запуска генерации.


eval {
    my $result = $api_instance->getReportInfo(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getReportInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
reportId = reportId_example # String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

try:
    # Получение заданного отчета
    api_response = api_instance.get_report_info(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getReportInfo: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let reportId = reportId_example; // String

    let mut context = ExpressApi::Context::default();
    let result = client.getReportInfo(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
reportId*
String
Идентификатор отчета, который вы получили после запуска генерации.
Required

Responses


getReturn

Информация о невыкупе или возврате

Получает информацию по одному невыкупу или возврату. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturn");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturn(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturn: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Информация о невыкупе или возврате
[apiInstance getReturnWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(GetReturnResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturn(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Информация о невыкупе или возврате
                GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getReturn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturn($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturn(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Информация о невыкупе или возврате
    api_response = api_instance.get_return(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getReturn: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getReturn(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnApplication

Получение заявления на возврат

Загружает заявление покупателя на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturnApplication(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnApplication: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Получение заявления на возврат
[apiInstance getReturnApplicationWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnApplication(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnApplicationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Получение заявления на возврат
                File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getReturnApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturnApplication($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getReturnApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturnApplication(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getReturnApplication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Получение заявления на возврат
    api_response = api_instance.get_return_application(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getReturnApplication: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getReturnApplication(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnPhoto

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final Long itemId = new Long(); // Long | Идентификатор товара в возврате.
final String imageHash = new String(); // String | Хеш ссылки изображения для загрузки.

try {
    final result = await api_instance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnPhoto: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
Long *itemId = 789; // Идентификатор товара в возврате. (default to null)
String *imageHash = imageHash_example; // Хеш ссылки изображения для загрузки. (default to null)

// Получение фотографии возврата
[apiInstance getReturnPhotoWith:campaignId
    orderId:orderId
    returnId:returnId
    itemId:itemId
    imageHash:imageHash
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var itemId = 789; // {Long} Идентификатор товара в возврате.
var imageHash = imageHash_example; // {String} Хеш ссылки изображения для загрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnPhotoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var itemId = 789;  // Long | Идентификатор товара в возврате. (default to null)
            var imageHash = imageHash_example;  // String | Хеш ссылки изображения для загрузки. (default to null)

            try {
                // Получение фотографии возврата
                File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getReturnPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$itemId = 789; // Long | Идентификатор товара в возврате.
$imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

try {
    $result = $api_instance->getReturnPhoto($campaignId, $orderId, $returnId, $itemId, $imageHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $itemId = 789; # Long | Идентификатор товара в возврате.
my $imageHash = imageHash_example; # String | Хеш ссылки изображения для загрузки.

eval {
    my $result = $api_instance->getReturnPhoto(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, itemId => $itemId, imageHash => $imageHash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getReturnPhoto: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
itemId = 789 # Long | Идентификатор товара в возврате. (default to null)
imageHash = imageHash_example # String | Хеш ссылки изображения для загрузки. (default to null)

try:
    # Получение фотографии возврата
    api_response = api_instance.get_return_photo(campaignId, orderId, returnId, itemId, imageHash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getReturnPhoto: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let itemId = 789; // Long
    let imageHash = imageHash_example; // String

    let mut context = ExpressApi::Context::default();
    let result = client.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
itemId*
Long (int64)
Идентификатор товара в возврате.
Required
imageHash*
String
Хеш ссылки изображения для загрузки.
Required

Responses


getReturns

Список невыкупов и возвратов

Получает список невыкупов и возвратов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос [GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}](../../reference/orders/getReturn.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/returns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&orderIds=&statuses=STARTED_BY_USER,WAITING_FOR_DECISION&type=&fromDate=2022-10-31&toDate=2022-11-30&from_date=2022-10-31&to_date=2022-11-30"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final array[Long] orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

final array[RefundStatusType] statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

final ReturnType type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

final date fromDate = new date(); // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date toDate = new date(); // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date fromDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

final date toDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    final result = await api_instance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturns: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getReturns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
array[Long] *orderIds = ; // Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
array[RefundStatusType] *statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
ReturnType *type = ; // Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
date *fromDate = 2022-10-31; // Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *toDate = 2022-11-30; // Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *fromDate2 = 2022-10-31; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
date *toDate2 = 2022-11-30; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

// Список невыкупов и возвратов
[apiInstance getReturnsWith:campaignId
    pageToken:pageToken
    limit:limit
    orderIds:orderIds
    statuses:statuses
    type:type
    fromDate:fromDate
    toDate:toDate
    fromDate2:fromDate2
    toDate2:toDate2
              completionHandler: ^(GetReturnsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'orderIds': , // {array[Long]} Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

  'statuses': STARTED_BY_USER,WAITING_FOR_DECISION, // {array[RefundStatusType]} Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

  'type': , // {ReturnType} Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

  'fromDate': 2022-10-31, // {date} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'toDate': 2022-11-30, // {date} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'fromDate2': 2022-10-31, // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

  'toDate2': 2022-11-30 // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturns(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional)  (default to null)
            var statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional)  (default to null)
            var type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional)  (default to null)
            var fromDate = 2022-10-31;  // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var toDate = 2022-11-30;  // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var fromDate2 = 2022-10-31;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)
            var toDate2 = 2022-11-30;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)

            try {
                // Список невыкупов и возвратов
                GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getReturns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

$type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

$fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

$toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    $result = $api_instance->getReturns($campaignId, $pageToken, $limit, $orderIds, $statuses, $type, $fromDate, $toDate, $fromDate2, $toDate2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getReturns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $orderIds = []; # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

my $statuses = [STARTED_BY_USER,WAITING_FOR_DECISION]; # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

my $type = ; # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

my $fromDate = 2022-10-31; # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $toDate = 2022-11-30; # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $fromDate2 = 2022-10-31; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

my $toDate2 = 2022-11-30; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


eval {
    my $result = $api_instance->getReturns(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, orderIds => $orderIds, statuses => $statuses, type => $type, fromDate => $fromDate, toDate => $toDate, fromDate2 => $fromDate2, toDate2 => $toDate2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getReturns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
orderIds =  # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
statuses = STARTED_BY_USER,WAITING_FOR_DECISION # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
type =  # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
fromDate = 2022-10-31 # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
toDate = 2022-11-30 # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
fromDate2 = 2022-10-31 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
toDate2 = 2022-11-30 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

try:
    # Список невыкупов и возвратов
    api_response = api_instance.get_returns(campaignId, pageToken=pageToken, limit=limit, orderIds=orderIds, statuses=statuses, type=type, fromDate=fromDate, toDate=toDate, fromDate2=fromDate2, toDate2=toDate2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getReturns: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let orderIds = ; // array[Long]
    let statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType]
    let type = ; // ReturnType
    let fromDate = 2022-10-31; // date
    let toDate = 2022-11-30; // date
    let fromDate2 = 2022-10-31; // date
    let toDate2 = 2022-11-30; // date

    let mut context = ExpressApi::Context::default();
    let result = client.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
orderIds
array[Long] (int64)
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
statuses
array[RefundStatusType]
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
type
ReturnType
Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.
fromDate
date (date)
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
toDate
date (date)
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
from_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `fromDate`. {% endnote %} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
to_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `toDate`. {% endnote %} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Responses


getStocks

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для всех моделей) и об [оборачиваемости](*turnover) товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте `true` в поле `withTurnover`. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке Маркета для продавцов https://yandex.ru/support/marketplace/analytics/turnover.html.)


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "withTurnover" : false,
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetWarehouseStocksRequest getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest | 

try {
    final result = await api_instance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStocks: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetWarehouseStocksRequest *getWarehouseStocksRequest = ; //  (optional)

// Информация об остатках и оборачиваемости
[apiInstance getStocksWith:campaignId
    pageToken:pageToken
    limit:limit
    getWarehouseStocksRequest:getWarehouseStocksRequest
              completionHandler: ^(GetWarehouseStocksResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getWarehouseStocksRequest':  // {GetWarehouseStocksRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStocks(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest |  (optional) 

            try {
                // Информация об остатках и оборачиваемости
                GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

try {
    $result = $api_instance->getStocks($campaignId, $pageToken, $limit, $getWarehouseStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getWarehouseStocksRequest = WWW::OPenAPIClient::Object::GetWarehouseStocksRequest->new(); # GetWarehouseStocksRequest | 

eval {
    my $result = $api_instance->getStocks(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getWarehouseStocksRequest => $getWarehouseStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getWarehouseStocksRequest =  # GetWarehouseStocksRequest |  (optional)

try:
    # Информация об остатках и оборачиваемости
    api_response = api_instance.get_stocks(campaignId, pageToken=pageToken, limit=limit, getWarehouseStocksRequest=getWarehouseStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getStocks: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getWarehouseStocksRequest = ; // GetWarehouseStocksRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getWarehouseStocksRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappingEntries

Рекомендованные карточки для товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/suggestions](../../reference/business-assortment/getSuggestedOfferMappings.md). {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/updates](../../reference/offer-mappings/updateOfferMappingEntries.md). В одном запросе можно получить не более 500 рекомендаций. |**⚙️ Лимит:** 100 000 рекомендаций в час| |-|


/campaigns/{campaignId}/offer-mapping-entries/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions" \
 -d '{
  "offers" : [ {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingEntriesRequest *getSuggestedOfferMappingEntriesRequest = ; // 

// Рекомендованные карточки для товаров
[apiInstance getSuggestedOfferMappingEntriesWith:campaignId
    getSuggestedOfferMappingEntriesRequest:getSuggestedOfferMappingEntriesRequest
              completionHandler: ^(GetSuggestedOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getSuggestedOfferMappingEntriesRequest = ; // {GetSuggestedOfferMappingEntriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

            try {
                // Рекомендованные карточки для товаров
                GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getSuggestedOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappingEntries($campaignId, $getSuggestedOfferMappingEntriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getSuggestedOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingEntriesRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingEntriesRequest->new(); # GetSuggestedOfferMappingEntriesRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappingEntries(campaignId => $campaignId, getSuggestedOfferMappingEntriesRequest => $getSuggestedOfferMappingEntriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getSuggestedOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingEntriesRequest =  # GetSuggestedOfferMappingEntriesRequest | 

try:
    # Рекомендованные карточки для товаров
    api_response = api_instance.get_suggested_offer_mapping_entries(campaignId, getSuggestedOfferMappingEntriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getSuggestedOfferMappingEntries: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingEntriesRequest *

Responses


getSuggestedOfferMappings

Просмотр карточек на Маркете, которые подходят вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами. Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным. **Как пользоваться запросом** 1. Передайте Маркету список товаров, которые нужно проверить. 2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией. 3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида `https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>`. 4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать `marketSKU`, который ему подходит по вашему мнению. {% note info "𝓠 Как определить `marketSku` товара, найденного на Маркете?" %} 𝓐 Он есть в адресе страницы товара — расположен после `sku=`. Например, `https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016` {% endnote %} |**⚙️ Лимит:** 100 000 товаров в час| |-|


/businesses/{businessId}/offer-mappings/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/suggestions" \
 -d '{
  "offers" : [ {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingsRequest *getSuggestedOfferMappingsRequest = ; //  (optional)

// Просмотр карточек на Маркете, которые подходят вашим товарам
[apiInstance getSuggestedOfferMappingsWith:businessId
    getSuggestedOfferMappingsRequest:getSuggestedOfferMappingsRequest
              completionHandler: ^(GetSuggestedOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getSuggestedOfferMappingsRequest':  // {GetSuggestedOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest |  (optional) 

            try {
                // Просмотр карточек на Маркете, которые подходят вашим товарам
                GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getSuggestedOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappings($businessId, $getSuggestedOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getSuggestedOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingsRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingsRequest->new(); # GetSuggestedOfferMappingsRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappings(businessId => $businessId, getSuggestedOfferMappingsRequest => $getSuggestedOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getSuggestedOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingsRequest =  # GetSuggestedOfferMappingsRequest |  (optional)

try:
    # Просмотр карточек на Маркете, которые подходят вашим товарам
    api_response = api_instance.get_suggested_offer_mappings(businessId, getSuggestedOfferMappingsRequest=getSuggestedOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getSuggestedOfferMappings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingsRequest

Responses


getSuggestedPrices

Цены для продвижения товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [отчет «Цены на рынке»](../../reference/reports/generatePricesReport.md). {% endnote %} {% note warning "" %} Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях. {% endnote %} Возвращает цены для продвижения товаров, которые вы размещаете на Маркете. Товары, для которых нужно получить цены, передаются в теле POST-запроса. Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене. Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения. Установить цены на товары можно с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md) или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете. Подробно об автоматическом управлении ценами рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/prices.html). |**⚙️ Лимит:** 100 000 товаров в час| |-|


/campaigns/{campaignId}/offer-prices/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions" \
 -d '{
  "offers" : [ {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SuggestPricesRequest suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

try {
    final result = await api_instance.getSuggestedPrices(campaignId, suggestPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedPrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SuggestPricesRequest *suggestPricesRequest = ; // 

// Цены для продвижения товаров
[apiInstance getSuggestedPricesWith:campaignId
    suggestPricesRequest:suggestPricesRequest
              completionHandler: ^(SuggestPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var suggestPricesRequest = ; // {SuggestPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedPrices(campaignId, suggestPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

            try {
                // Цены для продвижения товаров
                SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getSuggestedPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$suggestPricesRequest = ; // SuggestPricesRequest | 

try {
    $result = $api_instance->getSuggestedPrices($campaignId, $suggestPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getSuggestedPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $suggestPricesRequest = WWW::OPenAPIClient::Object::SuggestPricesRequest->new(); # SuggestPricesRequest | 

eval {
    my $result = $api_instance->getSuggestedPrices(campaignId => $campaignId, suggestPricesRequest => $suggestPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getSuggestedPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
suggestPricesRequest =  # SuggestPricesRequest | 

try:
    # Цены для продвижения товаров
    api_response = api_instance.get_suggested_prices(campaignId, suggestPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getSuggestedPrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let suggestPricesRequest = ; // SuggestPricesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.getSuggestedPrices(campaignId, suggestPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
suggestPricesRequest *

Responses


getWarehouses

Список складов и групп складов

Возвращает список складов и, если склады объединены, список групп складов. [Что такое группы складов и зачем они нужны](https://yandex.ru/support/marketplace/assortment/operations/stocks.html#unified-stocks) Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getWarehouses(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getWarehouses: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список складов и групп складов
[apiInstance getWarehousesWith:businessId
              completionHandler: ^(GetWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouses(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список складов и групп складов
                GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.getWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getWarehouses($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getWarehouses(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->getWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список складов и групп складов
    api_response = api_instance.get_warehouses(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->getWarehouses: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.getWarehouses(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


provideOrderItemIdentifiers

Передача кодов маркировки единиц товара

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Передает Маркету коды маркировки для единиц товара в указанном заказе. Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. {% note warning %} Прежде чем работать с этим методом, обязательно прочтите [статью о работе с маркируемыми товарами](https://yandex.ru/support/marketplace/orders/cz.html). {% endnote %} Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/identifiers

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers" \
 -d '{
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

try {
    final result = await api_instance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderItemIdentifiers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderItemIdentifiersRequest *provideOrderItemIdentifiersRequest = ; // 

// Передача кодов маркировки единиц товара
[apiInstance provideOrderItemIdentifiersWith:campaignId
    orderId:orderId
    provideOrderItemIdentifiersRequest:provideOrderItemIdentifiersRequest
              completionHandler: ^(ProvideOrderItemIdentifiersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderItemIdentifiersRequest = ; // {ProvideOrderItemIdentifiersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderItemIdentifiersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

            try {
                // Передача кодов маркировки единиц товара
                ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.provideOrderItemIdentifiers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

try {
    $result = $api_instance->provideOrderItemIdentifiers($campaignId, $orderId, $provideOrderItemIdentifiersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->provideOrderItemIdentifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderItemIdentifiersRequest = WWW::OPenAPIClient::Object::ProvideOrderItemIdentifiersRequest->new(); # ProvideOrderItemIdentifiersRequest | 

eval {
    my $result = $api_instance->provideOrderItemIdentifiers(campaignId => $campaignId, orderId => $orderId, provideOrderItemIdentifiersRequest => $provideOrderItemIdentifiersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->provideOrderItemIdentifiers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderItemIdentifiersRequest =  # ProvideOrderItemIdentifiersRequest | 

try:
    # Передача кодов маркировки единиц товара
    api_response = api_instance.provide_order_item_identifiers(campaignId, orderId, provideOrderItemIdentifiersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->provideOrderItemIdentifiers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderItemIdentifiersRequest *

Responses


putBidsForBusiness

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} ![](../../_images/api-boost.png) {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForBusiness(businessId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForBusiness: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок
[apiInstance putBidsForBusinessWith:businessId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForBusiness(businessId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок
                EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.putBidsForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForBusiness($businessId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForBusiness(businessId => $businessId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->putBidsForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок
    api_response = api_instance.put_bids_for_business(businessId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->putBidsForBusiness: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.putBidsForBusiness(businessId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


putBidsForCampaign

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или [PUT businesses/{businessId}/bids](/reference/bids/putBidsForBusiness). Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/campaigns/{campaignId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForCampaign(campaignId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForCampaign: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок для магазина
[apiInstance putBidsForCampaignWith:campaignId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForCampaign(campaignId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок для магазина
                EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.putBidsForCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForCampaign($campaignId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForCampaign(campaignId => $campaignId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->putBidsForCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок для магазина
    api_response = api_instance.put_bids_for_campaign(campaignId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->putBidsForCampaign: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.putBidsForCampaign(campaignId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


refreshFeed

Сообщить, что прайс-лист обновился

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом `POST campaigns/{campaignId}/feeds/{feedId}/refresh`. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — `200 OK`. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.refreshFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshFeed: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Сообщить, что прайс-лист обновился
[apiInstance refreshFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class refreshFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Сообщить, что прайс-лист обновился
                EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.refreshFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->refreshFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->refreshFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->refreshFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Сообщить, что прайс-лист обновился
    api_response = api_instance.refresh_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->refreshFeed: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.refreshFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


searchRegionChildren

Информация о дочерних регионах

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}/children

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}/children?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchRegionChildren(regionId, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionChildren: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о дочерних регионах
[apiInstance searchRegionChildrenWith:regionId
    page:page
    pageSize:pageSize
              completionHandler: ^(GetRegionWithChildrenResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionChildren(regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionChildrenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о дочерних регионах
                GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.searchRegionChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchRegionChildren($regionId, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->searchRegionChildren: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchRegionChildren(regionId => $regionId, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->searchRegionChildren: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о дочерних регионах
    api_response = api_instance.search_region_children(regionId, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->searchRegionChildren: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let regionId = 789; // Long
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.searchRegionChildren(regionId, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionsById

Информация о регионе

Возвращает информацию о регионе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    final result = await api_instance.searchRegionsById(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsById: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

// Информация о регионе
[apiInstance searchRegionsByIdWith:regionId
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsById(regionId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

            try {
                // Информация о регионе
                GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.searchRegionsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    $result = $api_instance->searchRegionsById($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->searchRegionsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


eval {
    my $result = $api_instance->searchRegionsById(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->searchRegionsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

try:
    # Информация о регионе
    api_response = api_instance.search_regions_by_id(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->searchRegionsById: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let regionId = 789; // Long

    let mut context = ExpressApi::Context::default();
    let result = client.searchRegionsById(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required

Responses


searchRegionsByName

Поиск регионов по их имени

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска. Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions?name=name_example&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchRegionsByName(name, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsByName: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
String *name = name_example; // Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Поиск регионов по их имени
[apiInstance searchRegionsByNameWith:name
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var name = name_example; // {String} Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsByName(name, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByNameExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var name = name_example;  // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Поиск регионов по их имени
                GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.searchRegionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchRegionsByName($name, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->searchRegionsByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $name = name_example; # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchRegionsByName(name => $name, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->searchRegionsByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
name = name_example # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Поиск регионов по их имени
    api_response = api_instance.search_regions_by_name(name, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->searchRegionsByName: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let name = name_example; // String
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ExpressApi::Context::default();
    let result = client.searchRegionsByName(name, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
name*
String
Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


sendFileToChat

Отправка файла в чат

Отправляет файл в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/file/send

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/file/send?chatId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final File file = new File(); // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    final result = await api_instance.sendFileToChat(businessId, chatId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendFileToChat: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
File *file = BINARY_DATA_HERE; // Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

// Отправка файла в чат
[apiInstance sendFileToChatWith:businessId
    chatId:chatId
    file:file
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var file = BINARY_DATA_HERE; // {File} Содержимое файла. Максимальный размер файла — 5 Мбайт.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFileToChat(businessId, chatId, file, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendFileToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var file = BINARY_DATA_HERE;  // File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

            try {
                // Отправка файла в чат
                EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.sendFileToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $api_instance->sendFileToChat($businessId, $chatId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $file = BINARY_DATA_HERE; # File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

eval {
    my $result = $api_instance->sendFileToChat(businessId => $businessId, chatId => $chatId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->sendFileToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
file = BINARY_DATA_HERE # File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

try:
    # Отправка файла в чат
    api_response = api_instance.send_file_to_chat(businessId, chatId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->sendFileToChat: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = ExpressApi::Context::default();
    let result = client.sendFileToChat(businessId, chatId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Form parameters
Name Description
file*
File (binary)
Содержимое файла. Максимальный размер файла — 5 Мбайт.
Required
Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


sendMessageToChat

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/message

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/message?chatId=789" \
 -d '{
  "message" : "message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final SendMessageToChatRequest sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

try {
    final result = await api_instance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendMessageToChat: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
SendMessageToChatRequest *sendMessageToChatRequest = ; // 

// Отправка сообщения в чат
[apiInstance sendMessageToChatWith:businessId
    chatId:chatId
    sendMessageToChatRequest:sendMessageToChatRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var sendMessageToChatRequest = ; // {SendMessageToChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendMessageToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

            try {
                // Отправка сообщения в чат
                EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.sendMessageToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$sendMessageToChatRequest = ; // SendMessageToChatRequest | 

try {
    $result = $api_instance->sendMessageToChat($businessId, $chatId, $sendMessageToChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $sendMessageToChatRequest = WWW::OPenAPIClient::Object::SendMessageToChatRequest->new(); # SendMessageToChatRequest | 

eval {
    my $result = $api_instance->sendMessageToChat(businessId => $businessId, chatId => $chatId, sendMessageToChatRequest => $sendMessageToChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->sendMessageToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
sendMessageToChatRequest =  # SendMessageToChatRequest | 

try:
    # Отправка сообщения в чат
    api_response = api_instance.send_message_to_chat(businessId, chatId, sendMessageToChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->sendMessageToChat: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let sendMessageToChatRequest = ; // SendMessageToChatRequest

    let mut context = ExpressApi::Context::default();
    let result = client.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
sendMessageToChatRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


setFeedParams

Изменение параметров прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: `name` (название параметра) и `value` (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: `name` (название параметра) и `delete=true` (удалить значение). |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/params

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/params" \
 -d '{
  "parameters" : [ {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  }, {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final SetFeedParamsRequest setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

try {
    final result = await api_instance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setFeedParams: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
SetFeedParamsRequest *setFeedParamsRequest = ; // 

// Изменение параметров прайс-листа
[apiInstance setFeedParamsWith:campaignId
    feedId:feedId
    setFeedParamsRequest:setFeedParamsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var setFeedParamsRequest = ; // {SetFeedParamsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFeedParams(campaignId, feedId, setFeedParamsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setFeedParamsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

            try {
                // Изменение параметров прайс-листа
                EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.setFeedParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$setFeedParamsRequest = ; // SetFeedParamsRequest | 

try {
    $result = $api_instance->setFeedParams($campaignId, $feedId, $setFeedParamsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $setFeedParamsRequest = WWW::OPenAPIClient::Object::SetFeedParamsRequest->new(); # SetFeedParamsRequest | 

eval {
    my $result = $api_instance->setFeedParams(campaignId => $campaignId, feedId => $feedId, setFeedParamsRequest => $setFeedParamsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->setFeedParams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
setFeedParamsRequest =  # SetFeedParamsRequest | 

try:
    # Изменение параметров прайс-листа
    api_response = api_instance.set_feed_params(campaignId, feedId, setFeedParamsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->setFeedParams: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let setFeedParamsRequest = ; // SetFeedParamsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.setFeedParams(campaignId, feedId, setFeedParamsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Body parameters
Name Description
setFeedParamsRequest *

Responses


setOrderBoxLayout

Подготовка заказа

{% note tip "Подходит и для DBS" %} Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно. {% endnote %} Позволяет выполнить три операции: * передать Маркету информацию о распределении товаров по коробкам; * передать Маркету коды маркировки для товаров; * удалить товар из заказа, если его не оказалось на складе. Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус **Готов к отгрузке**. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново. ## Как передать информацию о распределении товаров В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов: * **Содержащие товары целиком.** Такая коробка может содержать сколько угодно единиц любых товаров. * **Содержащие часть товара.** Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок. ⚠️ Одна коробка не может содержать и товары целиком, и части товаров. ## Как передавать коды маркировки Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. [Что такое маркировка?](https://yandex.ru/support/marketplace/orders/cz.html) Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них. ## Как удалить товар из заказа Чтобы удалить товар из заказа: 1. Добавьте в запрос `allowRemove: true`. 2. Передайте распределение по коробкам без товара, который нужно удалить. {% note warning "Удаление нельзя отменить" %} Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится. {% endnote %} Чтобы удалить позицию целиком, не передавайте соответствующий `OrderBoxLayoutItemDTO`. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле `fullCount`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} ## Примеры {% cut "Товар умещается в коробку" %} Вот как будет выглядеть запрос, если в одной коробке едут: * три единицы одного товара, требующего маркировки; * одна единица другого товара, не требущего маркировки. ```json { "boxes": [ { "items": [ { "id": 123456, "fullCount": 3, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" }, { "cis": "010304109478gftJ14545762!\u001dhGt264" }, { "cis": "010304109478fRs28323ks23!\u001dhet201" } ] }, { "id": 654321, "fullCount": 1 } ] } ] } ``` {% endcut %} {% cut "Товар едет в разных коробках" %} Вот как будет выглядеть запрос, если товар едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} {% cut "Одинаковые товары, где каждый едет в нескольких коробках" %} Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/boxes" \
 -d '{
  "boxes" : [ {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  }, {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  } ],
  "allowRemove" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

try {
    final result = await api_instance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderBoxLayout: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderBoxLayoutRequest *setOrderBoxLayoutRequest = ; // 

// Подготовка заказа
[apiInstance setOrderBoxLayoutWith:campaignId
    orderId:orderId
    setOrderBoxLayoutRequest:setOrderBoxLayoutRequest
              completionHandler: ^(SetOrderBoxLayoutResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderBoxLayoutRequest = ; // {SetOrderBoxLayoutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderBoxLayoutExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

            try {
                // Подготовка заказа
                SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.setOrderBoxLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

try {
    $result = $api_instance->setOrderBoxLayout($campaignId, $orderId, $setOrderBoxLayoutRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->setOrderBoxLayout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderBoxLayoutRequest = WWW::OPenAPIClient::Object::SetOrderBoxLayoutRequest->new(); # SetOrderBoxLayoutRequest | 

eval {
    my $result = $api_instance->setOrderBoxLayout(campaignId => $campaignId, orderId => $orderId, setOrderBoxLayoutRequest => $setOrderBoxLayoutRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->setOrderBoxLayout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderBoxLayoutRequest =  # SetOrderBoxLayoutRequest | 

try:
    # Подготовка заказа
    api_response = api_instance.set_order_box_layout(campaignId, orderId, setOrderBoxLayoutRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->setOrderBoxLayout: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest

    let mut context = ExpressApi::Context::default();
    let result = client.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderBoxLayoutRequest *

Responses


setOrderShipmentBoxes

Передача количества грузовых мест в заказе

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест. Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус **Готов к отгрузке**. Подробно о том, что в какой момент нужно передавать, рассказано в [пошаговой инструкции](../../step-by-step/fbs.md). Метод устроен немного нестандартно: количество задается длиной массива пустых объектов. Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому. {% cut "Как было раньше" %} Структура тела PUT-запроса: ``` { "boxes": [ { "fulfilmentId": "{string}", "weight": {int64}, "width": {int64}, "height": {int64}, "depth": {int64}, "items": [ { "id": {int64}, "count": {int32} }, ... ] }, ... ] } ``` | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `boxes` | | Список грузовых мест. | **Параметры, вложенные в `boxes`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `fulfilmentId` | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: `номер заказа на Маркете-номер грузового места`. Например, `7206821‑1, 7206821‑2` и т. д. | | `weight` | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | `width` | Int64 | Ширина грузового места в сантиметрах. | | `height` | Int64 | Высота грузового места в сантиметрах. | | `depth` | Int64 | Глубина грузового места в сантиметрах. | | `items` | Int64 | Список товаров в грузовом месте. | **Параметры, вложенные в `items`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `id` | Int64 | Идентификатор товара в рамках заказа. | | `count` | Int32 | Количество единиц товара в грузовом месте. | {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes" \
 -d '{
  "boxes" : [ {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  }, {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

final SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

try {
    final result = await api_instance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderShipmentBoxes: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
SetOrderShipmentBoxesRequest *setOrderShipmentBoxesRequest = ; // 

// Передача количества грузовых мест в заказе
[apiInstance setOrderShipmentBoxesWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    setOrderShipmentBoxesRequest:setOrderShipmentBoxesRequest
              completionHandler: ^(SetOrderShipmentBoxesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

var setOrderShipmentBoxesRequest = ; // {SetOrderShipmentBoxesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderShipmentBoxesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
            var setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

            try {
                // Передача количества грузовых мест в заказе
                SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.setOrderShipmentBoxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

$setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

try {
    $result = $api_instance->setOrderShipmentBoxes($campaignId, $orderId, $shipmentId, $setOrderShipmentBoxesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->setOrderShipmentBoxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

my $setOrderShipmentBoxesRequest = WWW::OPenAPIClient::Object::SetOrderShipmentBoxesRequest->new(); # SetOrderShipmentBoxesRequest | 

eval {
    my $result = $api_instance->setOrderShipmentBoxes(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, setOrderShipmentBoxesRequest => $setOrderShipmentBoxesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->setOrderShipmentBoxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
setOrderShipmentBoxesRequest =  # SetOrderShipmentBoxesRequest | 

try:
    # Передача количества грузовых мест в заказе
    api_response = api_instance.set_order_shipment_boxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->setOrderShipmentBoxes: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
Required
Body parameters
Name Description
setOrderShipmentBoxesRequest *

Responses


skipGoodsFeedbacksReaction

Отказ от ответа на отзывы

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов [POST businesses/{businessId}/goods-feedback](../../reference/goods-feedback/getGoodsFeedbacks.md). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/skip-reaction

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/skip-reaction" \
 -d '{
  "feedbackIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

try {
    final result = await api_instance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->skipGoodsFeedbacksReaction: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SkipGoodsFeedbackReactionRequest *skipGoodsFeedbackReactionRequest = ; // 

// Отказ от ответа на отзывы
[apiInstance skipGoodsFeedbacksReactionWith:businessId
    skipGoodsFeedbackReactionRequest:skipGoodsFeedbackReactionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var skipGoodsFeedbackReactionRequest = ; // {SkipGoodsFeedbackReactionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class skipGoodsFeedbacksReactionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

            try {
                // Отказ от ответа на отзывы
                EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.skipGoodsFeedbacksReaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

try {
    $result = $api_instance->skipGoodsFeedbacksReaction($businessId, $skipGoodsFeedbackReactionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->skipGoodsFeedbacksReaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $skipGoodsFeedbackReactionRequest = WWW::OPenAPIClient::Object::SkipGoodsFeedbackReactionRequest->new(); # SkipGoodsFeedbackReactionRequest | 

eval {
    my $result = $api_instance->skipGoodsFeedbacksReaction(businessId => $businessId, skipGoodsFeedbackReactionRequest => $skipGoodsFeedbackReactionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->skipGoodsFeedbacksReaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
skipGoodsFeedbackReactionRequest =  # SkipGoodsFeedbackReactionRequest | 

try:
    # Отказ от ответа на отзывы
    api_response = api_instance.skip_goods_feedbacks_reaction(businessId, skipGoodsFeedbackReactionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->skipGoodsFeedbacksReaction: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest

    let mut context = ExpressApi::Context::default();
    let result = client.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
skipGoodsFeedbackReactionRequest *

Responses


updateBusinessPrices

Установка цен на товары во всех магазинах

Устанавливает [базовые цены](*default-price). Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateBusinessPricesRequest updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

try {
    final result = await api_instance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateBusinessPrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateBusinessPricesRequest *updateBusinessPricesRequest = ; // 

// Установка цен на товары во всех магазинах
[apiInstance updateBusinessPricesWith:businessId
    updateBusinessPricesRequest:updateBusinessPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateBusinessPricesRequest = ; // {UpdateBusinessPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBusinessPrices(businessId, updateBusinessPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

            try {
                // Установка цен на товары во всех магазинах
                EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

try {
    $result = $api_instance->updateBusinessPrices($businessId, $updateBusinessPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateBusinessPricesRequest = WWW::OPenAPIClient::Object::UpdateBusinessPricesRequest->new(); # UpdateBusinessPricesRequest | 

eval {
    my $result = $api_instance->updateBusinessPrices(businessId => $businessId, updateBusinessPricesRequest => $updateBusinessPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateBusinessPricesRequest =  # UpdateBusinessPricesRequest | 

try:
    # Установка цен на товары во всех магазинах
    api_response = api_instance.update_business_prices(businessId, updateBusinessPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateBusinessPrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateBusinessPrices(businessId, updateBusinessPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateBusinessPricesRequest *

Responses


updateCampaignOffers

Изменение условий продажи товаров в магазине

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/update" \
 -d '{
  "offers" : [ {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateCampaignOffersRequest updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

try {
    final result = await api_instance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCampaignOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateCampaignOffersRequest *updateCampaignOffersRequest = ; // 

// Изменение условий продажи товаров в магазине
[apiInstance updateCampaignOffersWith:campaignId
    updateCampaignOffersRequest:updateCampaignOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateCampaignOffersRequest = ; // {UpdateCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCampaignOffers(campaignId, updateCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

            try {
                // Изменение условий продажи товаров в магазине
                EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

try {
    $result = $api_instance->updateCampaignOffers($campaignId, $updateCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateCampaignOffersRequest = WWW::OPenAPIClient::Object::UpdateCampaignOffersRequest->new(); # UpdateCampaignOffersRequest | 

eval {
    my $result = $api_instance->updateCampaignOffers(campaignId => $campaignId, updateCampaignOffersRequest => $updateCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateCampaignOffersRequest =  # UpdateCampaignOffersRequest | 

try:
    # Изменение условий продажи товаров в магазине
    api_response = api_instance.update_campaign_offers(campaignId, updateCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateCampaignOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateCampaignOffers(campaignId, updateCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateCampaignOffersRequest *

Responses


updateGoodsFeedbackComment

Добавление нового или изменение созданного комментария

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее. Для создания комментария к отзыву передайте только идентификатор отзыва `feedbackId`. Чтобы добавить комментарий к другому комментарию, передайте: * `feedbackId` — идентификатор отзыва; * `comment.parentId` — идентификатор родительского комментария. Чтобы изменить комментарий, передайте: * `feedbackId`— идентификатор отзыва; * `comment.id` — идентификатор комментария, который нужно изменить. Если передать одновременно `comment.parentId` и `comment.id`, будет изменен существующий комментарий. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/update" \
 -d '{
  "feedbackId" : 0,
  "comment" : {
    "id" : 6,
    "text" : "text",
    "parentId" : 1
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateGoodsFeedbackCommentRequest *updateGoodsFeedbackCommentRequest = ; // 

// Добавление нового или изменение созданного комментария
[apiInstance updateGoodsFeedbackCommentWith:businessId
    updateGoodsFeedbackCommentRequest:updateGoodsFeedbackCommentRequest
              completionHandler: ^(UpdateGoodsFeedbackCommentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateGoodsFeedbackCommentRequest = ; // {UpdateGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

            try {
                // Добавление нового или изменение созданного комментария
                UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->updateGoodsFeedbackComment($businessId, $updateGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::UpdateGoodsFeedbackCommentRequest->new(); # UpdateGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->updateGoodsFeedbackComment(businessId => $businessId, updateGoodsFeedbackCommentRequest => $updateGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateGoodsFeedbackCommentRequest =  # UpdateGoodsFeedbackCommentRequest | 

try:
    # Добавление нового или изменение созданного комментария
    api_response = api_instance.update_goods_feedback_comment(businessId, updateGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateGoodsFeedbackComment: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateGoodsFeedbackCommentRequest *

Responses


updateOfferContent

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Чтобы удалить характеристики, которые заданы в параметрах с типом `string`, передайте пустое значение. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/businesses/{businessId}/offer-cards/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards/update" \
 -d '{
  "offersContent" : [ {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferContentRequest updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

try {
    final result = await api_instance.updateOfferContent(businessId, updateOfferContentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferContent: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferContentRequest *updateOfferContentRequest = ; // 

// Редактирование категорийных характеристик товара
[apiInstance updateOfferContentWith:businessId
    updateOfferContentRequest:updateOfferContentRequest
              completionHandler: ^(UpdateOfferContentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferContentRequest = ; // {UpdateOfferContentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferContent(businessId, updateOfferContentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferContentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

            try {
                // Редактирование категорийных характеристик товара
                UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOfferContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferContentRequest = ; // UpdateOfferContentRequest | 

try {
    $result = $api_instance->updateOfferContent($businessId, $updateOfferContentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferContentRequest = WWW::OPenAPIClient::Object::UpdateOfferContentRequest->new(); # UpdateOfferContentRequest | 

eval {
    my $result = $api_instance->updateOfferContent(businessId => $businessId, updateOfferContentRequest => $updateOfferContentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOfferContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferContentRequest =  # UpdateOfferContentRequest | 

try:
    # Редактирование категорийных характеристик товара
    api_response = api_instance.update_offer_content(businessId, updateOfferContentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOfferContent: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferContentRequest = ; // UpdateOfferContentRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOfferContent(businessId, updateOfferContentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferContentRequest *

Responses


updateOfferMappingEntries

Добавление и редактирование товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре `shopSku` ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре `shopSku` ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/suggestions](../../reference/offer-mappings/getSuggestedOfferMappingEntries.md) или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус `NEED_CONTENT` (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус `NEED_INFO` (в описании товара не хватает информации) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5 000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-mapping-entries/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/updates" \
 -d '{
  "offerMappingEntries" : [ {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

try {
    final result = await api_instance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingEntryRequest *updateOfferMappingEntryRequest = ; // 

// Добавление и редактирование товаров в каталоге
[apiInstance updateOfferMappingEntriesWith:campaignId
    updateOfferMappingEntryRequest:updateOfferMappingEntryRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingEntryRequest = ; // {UpdateOfferMappingEntryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

            try {
                // Добавление и редактирование товаров в каталоге
                EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

try {
    $result = $api_instance->updateOfferMappingEntries($campaignId, $updateOfferMappingEntryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingEntryRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingEntryRequest->new(); # UpdateOfferMappingEntryRequest | 

eval {
    my $result = $api_instance->updateOfferMappingEntries(campaignId => $campaignId, updateOfferMappingEntryRequest => $updateOfferMappingEntryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingEntryRequest =  # UpdateOfferMappingEntryRequest | 

try:
    # Добавление и редактирование товаров в каталоге
    api_response = api_instance.update_offer_mapping_entries(campaignId, updateOfferMappingEntryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOfferMappingEntries: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingEntryRequest *

Responses


updateOfferMappings

Добавление товаров в каталог и изменение информации о них

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах. Список категорий Маркета можно получить с помощью запроса [POST categories/tree](../../reference/categories/getCategoriesTree.md), а характеристики товаров по категориям с помощью [POST category/{categoryId}/parameters](../../reference/content/getCategoryContentParameters.md). Чтобы **добавить новый товар**, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (**SKU на Маркете**) в поле `marketSKU`. Для **новых товаров** обязательно укажите параметры: `offerId`, `name`, `marketCategoryId` или `category`, `pictures`, `vendor`, `description`. Чтобы **отредактировать информацию о товаре**, передайте новые данные, указав в `offerId` соответствующий **ваш SKU**. Поля, в которых ничего не меняется, можно не передавать. Чтобы **удалить характеристики**, которые заданы в параметрах с типом `string`, передайте пустое значение. Параметр `offerId` должен быть **уникальным** для всех товаров, которые вы передаете. {% note warning "Правила использования SKU" %} * У каждого товара SKU должен быть свой. * SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. * Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update" \
 -d '{
  "offerMappings" : [ {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  } ],
  "onlyPartnerMediaContent" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingsRequest updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

try {
    final result = await api_instance.updateOfferMappings(businessId, updateOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappings: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingsRequest *updateOfferMappingsRequest = ; // 

// Добавление товаров в каталог и изменение информации о них
[apiInstance updateOfferMappingsWith:businessId
    updateOfferMappingsRequest:updateOfferMappingsRequest
              completionHandler: ^(UpdateOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingsRequest = ; // {UpdateOfferMappingsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappings(businessId, updateOfferMappingsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

            try {
                // Добавление товаров в каталог и изменение информации о них
                UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

try {
    $result = $api_instance->updateOfferMappings($businessId, $updateOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingsRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingsRequest->new(); # UpdateOfferMappingsRequest | 

eval {
    my $result = $api_instance->updateOfferMappings(businessId => $businessId, updateOfferMappingsRequest => $updateOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingsRequest =  # UpdateOfferMappingsRequest | 

try:
    # Добавление товаров в каталог и изменение информации о них
    api_response = api_instance.update_offer_mappings(businessId, updateOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOfferMappings: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOfferMappings(businessId, updateOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingsRequest *

Responses


updateOrderItems

Удаление товара из заказа или уменьшение числа единиц

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях: * покупатель уменьшил количество товара; * магазин не может поставить все товары в заказе. Для этого заказ должен находится в статусе `"status": "PROCESSING"` этапа обработки `"substatus": "STARTED"`. После передачи статуса `"substatus": "READY_TO_SHIP"` изменить состав невозможно. Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте `count` параметра `item`. Чтобы полностью удалить товар из заказа: * передайте значение `0`; или * не передавайте параметр `item`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} **Возврат денег покупателю** Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней: * при оплате банковской картой — с момента, когда магазин переведет заказ в статус `SHIPPED`; * при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/items

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/items" \
 -d '{
  "reason" : "PARTNER_REQUESTED_REMOVE",
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderItemRequest updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

try {
    final result = await api_instance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderItems: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderItemRequest *updateOrderItemRequest = ; // 

// Удаление товара из заказа или уменьшение числа единиц
[apiInstance updateOrderItemsWith:campaignId
    orderId:orderId
    updateOrderItemRequest:updateOrderItemRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderItemRequest = ; // {UpdateOrderItemRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrderItems(campaignId, orderId, updateOrderItemRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderItemsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

            try {
                // Удаление товара из заказа или уменьшение числа единиц
                apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOrderItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderItemRequest = ; // UpdateOrderItemRequest | 

try {
    $api_instance->updateOrderItems($campaignId, $orderId, $updateOrderItemRequest);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderItemRequest = WWW::OPenAPIClient::Object::UpdateOrderItemRequest->new(); # UpdateOrderItemRequest | 

eval {
    $api_instance->updateOrderItems(campaignId => $campaignId, orderId => $orderId, updateOrderItemRequest => $updateOrderItemRequest);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOrderItems: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderItemRequest =  # UpdateOrderItemRequest | 

try:
    # Удаление товара из заказа или уменьшение числа единиц
    api_instance.update_order_items(campaignId, orderId, updateOrderItemRequest)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOrderItems: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderItemRequest = ; // UpdateOrderItemRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOrderItems(campaignId, orderId, updateOrderItemRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderItemRequest *

Responses


updateOrderStatus

Изменение статуса одного заказа

Изменяет статус заказа. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/status

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/status" \
 -d '{
  "order" : {
    "delivery" : {
      "dates" : {
        "realDeliveryDate" : "2000-01-23"
      }
    },
    "substatus" : "RESERVATION_EXPIRED",
    "status" : "PLACING"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStatusRequest updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

try {
    final result = await api_instance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatus: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStatusRequest *updateOrderStatusRequest = ; // 

// Изменение статуса одного заказа
[apiInstance updateOrderStatusWith:campaignId
    orderId:orderId
    updateOrderStatusRequest:updateOrderStatusRequest
              completionHandler: ^(UpdateOrderStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStatusRequest = ; // {UpdateOrderStatusRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

            try {
                // Изменение статуса одного заказа
                UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOrderStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

try {
    $result = $api_instance->updateOrderStatus($campaignId, $orderId, $updateOrderStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOrderStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStatusRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusRequest->new(); # UpdateOrderStatusRequest | 

eval {
    my $result = $api_instance->updateOrderStatus(campaignId => $campaignId, orderId => $orderId, updateOrderStatusRequest => $updateOrderStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOrderStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStatusRequest =  # UpdateOrderStatusRequest | 

try:
    # Изменение статуса одного заказа
    api_response = api_instance.update_order_status(campaignId, orderId, updateOrderStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOrderStatus: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStatusRequest = ; // UpdateOrderStatusRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStatusRequest *

Responses


updateOrderStatuses

Изменение статусов нескольких заказов

Изменяет статусы нескольких заказов. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"`и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/status-update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/status-update" \
 -d '{
  "orders" : [ {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOrderStatusesRequest updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

try {
    final result = await api_instance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatuses: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOrderStatusesRequest *updateOrderStatusesRequest = ; // 

// Изменение статусов нескольких заказов
[apiInstance updateOrderStatusesWith:campaignId
    updateOrderStatusesRequest:updateOrderStatusesRequest
              completionHandler: ^(UpdateOrderStatusesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOrderStatusesRequest = ; // {UpdateOrderStatusesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatuses(campaignId, updateOrderStatusesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

            try {
                // Изменение статусов нескольких заказов
                UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateOrderStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

try {
    $result = $api_instance->updateOrderStatuses($campaignId, $updateOrderStatusesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateOrderStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOrderStatusesRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusesRequest->new(); # UpdateOrderStatusesRequest | 

eval {
    my $result = $api_instance->updateOrderStatuses(campaignId => $campaignId, updateOrderStatusesRequest => $updateOrderStatusesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateOrderStatuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOrderStatusesRequest =  # UpdateOrderStatusesRequest | 

try:
    # Изменение статусов нескольких заказов
    api_response = api_instance.update_order_statuses(campaignId, updateOrderStatusesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateOrderStatuses: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateOrderStatuses(campaignId, updateOrderStatusesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOrderStatusesRequest *

Responses


updatePrices

Установка цен на товары в конкретном магазине

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для управления базовыми ценами используйте [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updatePrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePricesRequest updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

try {
    final result = await api_instance.updatePrices(campaignId, updatePricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePrices: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updatePrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePricesRequest *updatePricesRequest = ; // 

// Установка цен на товары в конкретном магазине
[apiInstance updatePricesWith:campaignId
    updatePricesRequest:updatePricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePricesRequest = ; // {UpdatePricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePrices(campaignId, updatePricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

            try {
                // Установка цен на товары в конкретном магазине
                EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updatePrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePricesRequest = ; // UpdatePricesRequest | 

try {
    $result = $api_instance->updatePrices($campaignId, $updatePricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updatePrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePricesRequest = WWW::OPenAPIClient::Object::UpdatePricesRequest->new(); # UpdatePricesRequest | 

eval {
    my $result = $api_instance->updatePrices(campaignId => $campaignId, updatePricesRequest => $updatePricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updatePrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePricesRequest =  # UpdatePricesRequest | 

try:
    # Установка цен на товары в конкретном магазине
    api_response = api_instance.update_prices(campaignId, updatePricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updatePrices: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let updatePricesRequest = ; // UpdatePricesRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updatePrices(campaignId, updatePricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePricesRequest *

Responses


updatePromoOffers

Добавление товаров в акцию или изменение их цен

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/update" \
 -d '{
  "offers" : [ {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  } ],
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePromoOffersRequest updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

try {
    final result = await api_instance.updatePromoOffers(businessId, updatePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePromoOffers: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePromoOffersRequest *updatePromoOffersRequest = ; // 

// Добавление товаров в акцию или изменение их цен
[apiInstance updatePromoOffersWith:businessId
    updatePromoOffersRequest:updatePromoOffersRequest
              completionHandler: ^(UpdatePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePromoOffersRequest = ; // {UpdatePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePromoOffers(businessId, updatePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

            try {
                // Добавление товаров в акцию или изменение их цен
                UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updatePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

try {
    $result = $api_instance->updatePromoOffers($businessId, $updatePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updatePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePromoOffersRequest = WWW::OPenAPIClient::Object::UpdatePromoOffersRequest->new(); # UpdatePromoOffersRequest | 

eval {
    my $result = $api_instance->updatePromoOffers(businessId => $businessId, updatePromoOffersRequest => $updatePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updatePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePromoOffersRequest =  # UpdatePromoOffersRequest | 

try:
    # Добавление товаров в акцию или изменение их цен
    api_response = api_instance.update_promo_offers(businessId, updatePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updatePromoOffers: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let businessId = 789; // Long
    let updatePromoOffersRequest = ; // UpdatePromoOffersRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updatePromoOffers(businessId, updatePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePromoOffersRequest *

Responses


updateStocks

Передача информации об остатках

Передает данные об остатках товаров на витрине. Обязательно указывайте SKU **в точности** так, как он указан в каталоге. Например, _557722_ и _0557722_ — это два разных SKU. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks" \
 -d '{
  "skus" : [ {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateStocksRequest updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

try {
    final result = await api_instance.updateStocks(campaignId, updateStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStocks: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#updateStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateStocksRequest *updateStocksRequest = ; // 

// Передача информации об остатках
[apiInstance updateStocksWith:campaignId
    updateStocksRequest:updateStocksRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateStocksRequest = ; // {UpdateStocksRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStocks(campaignId, updateStocksRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

            try {
                // Передача информации об остатках
                EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.updateStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateStocksRequest = ; // UpdateStocksRequest | 

try {
    $result = $api_instance->updateStocks($campaignId, $updateStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->updateStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateStocksRequest = WWW::OPenAPIClient::Object::UpdateStocksRequest->new(); # UpdateStocksRequest | 

eval {
    my $result = $api_instance->updateStocks(campaignId => $campaignId, updateStocksRequest => $updateStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->updateStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateStocksRequest =  # UpdateStocksRequest | 

try:
    # Передача информации об остатках
    api_response = api_instance.update_stocks(campaignId, updateStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->updateStocks: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateStocksRequest = ; // UpdateStocksRequest

    let mut context = ExpressApi::Context::default();
    let result = client.updateStocks(campaignId, updateStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateStocksRequest *

Responses


verifyOrderEac

Передача кода подтверждения

Отправляет Маркету код подтверждения для его проверки. Код подтверждает передачу заказа или невыкупа: * курьеру — курьер должен назвать магазину код; * магазину — магазин называет код курьеру. Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения. Если у магазина настроена работа с кодами подтверждения, в запросах [POST order/status](../../pushapi/reference/postOrderStatus.md), [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md), [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md), [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) в параметре `delivery`, вложенном в `order` будет возвращаться параметр `eacType` с типом `Enum` — тип кода подтверждения для передачи заказа. Возможные значения: `MERCHANT_TO_COURIER` — магазин называет код курьеру, `COURIER_TO_MERCHANT` — курьер называет код магазину. Параметр `eacType` возвращается при статусах заказа `COURIER_FOUND`, `COURIER_ARRIVED_TO_SENDER` и `DELIVERY_SERVICE_UNDELIVERED`. Если заказ в других статусах, параметр может отсутствовать. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/verifyEac

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/verifyEac" \
 -d '{
  "code" : "code"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExpressApi;

import java.io.File;
import java.util.*;

public class ExpressApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        VerifyOrderEacRequest verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

        try {
            VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#verifyOrderEac");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final VerifyOrderEacRequest verifyOrderEacRequest = new VerifyOrderEacRequest(); // VerifyOrderEacRequest | 

try {
    final result = await api_instance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->verifyOrderEac: $e\n');
}

import org.openapitools.client.api.ExpressApi;

public class ExpressApiExample {
    public static void main(String[] args) {
        ExpressApi apiInstance = new ExpressApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        VerifyOrderEacRequest verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

        try {
            VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExpressApi#verifyOrderEac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ExpressApi *apiInstance = [[ExpressApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
VerifyOrderEacRequest *verifyOrderEacRequest = ; // 

// Передача кода подтверждения
[apiInstance verifyOrderEacWith:campaignId
    orderId:orderId
    verifyOrderEacRequest:verifyOrderEacRequest
              completionHandler: ^(VerifyOrderEacResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ExpressApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var verifyOrderEacRequest = ; // {VerifyOrderEacRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class verifyOrderEacExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ExpressApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var verifyOrderEacRequest = new VerifyOrderEacRequest(); // VerifyOrderEacRequest | 

            try {
                // Передача кода подтверждения
                VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExpressApi.verifyOrderEac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExpressApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

try {
    $result = $api_instance->verifyOrderEac($campaignId, $orderId, $verifyOrderEacRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExpressApi->verifyOrderEac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExpressApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExpressApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $verifyOrderEacRequest = WWW::OPenAPIClient::Object::VerifyOrderEacRequest->new(); # VerifyOrderEacRequest | 

eval {
    my $result = $api_instance->verifyOrderEac(campaignId => $campaignId, orderId => $orderId, verifyOrderEacRequest => $verifyOrderEacRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExpressApi->verifyOrderEac: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ExpressApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
verifyOrderEacRequest =  # VerifyOrderEacRequest | 

try:
    # Передача кода подтверждения
    api_response = api_instance.verify_order_eac(campaignId, orderId, verifyOrderEacRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExpressApi->verifyOrderEac: %s\n" % e)
extern crate ExpressApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let verifyOrderEacRequest = ; // VerifyOrderEacRequest

    let mut context = ExpressApi::Context::default();
    let result = client.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
verifyOrderEacRequest *

Responses


Fbs

addHiddenOffers

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddHiddenOffersRequest addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

try {
    final result = await api_instance.addHiddenOffers(campaignId, addHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddHiddenOffersRequest *addHiddenOffersRequest = ; // 

// Скрытие товаров и настройки скрытия
[apiInstance addHiddenOffersWith:campaignId
    addHiddenOffersRequest:addHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addHiddenOffersRequest = ; // {AddHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addHiddenOffers(campaignId, addHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

            try {
                // Скрытие товаров и настройки скрытия
                EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.addHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

try {
    $result = $api_instance->addHiddenOffers($campaignId, $addHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->addHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addHiddenOffersRequest = WWW::OPenAPIClient::Object::AddHiddenOffersRequest->new(); # AddHiddenOffersRequest | 

eval {
    my $result = $api_instance->addHiddenOffers(campaignId => $campaignId, addHiddenOffersRequest => $addHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->addHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addHiddenOffersRequest =  # AddHiddenOffersRequest | 

try:
    # Скрытие товаров и настройки скрытия
    api_response = api_instance.add_hidden_offers(campaignId, addHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->addHiddenOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let addHiddenOffersRequest = ; // AddHiddenOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.addHiddenOffers(campaignId, addHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addHiddenOffersRequest *

Запрос на скрытие оферов.

Responses


addOffersToArchive

Добавление товаров в архив

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета. {% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %} Вначале такой товар нужно распродать или вывезти. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/archive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/archive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddOffersToArchiveRequest addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

try {
    final result = await api_instance.addOffersToArchive(businessId, addOffersToArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOffersToArchive: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddOffersToArchiveRequest *addOffersToArchiveRequest = ; // 

// Добавление товаров в архив
[apiInstance addOffersToArchiveWith:businessId
    addOffersToArchiveRequest:addOffersToArchiveRequest
              completionHandler: ^(AddOffersToArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addOffersToArchiveRequest = ; // {AddOffersToArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOffersToArchive(businessId, addOffersToArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addOffersToArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

            try {
                // Добавление товаров в архив
                AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.addOffersToArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

try {
    $result = $api_instance->addOffersToArchive($businessId, $addOffersToArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->addOffersToArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addOffersToArchiveRequest = WWW::OPenAPIClient::Object::AddOffersToArchiveRequest->new(); # AddOffersToArchiveRequest | 

eval {
    my $result = $api_instance->addOffersToArchive(businessId => $businessId, addOffersToArchiveRequest => $addOffersToArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->addOffersToArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addOffersToArchiveRequest =  # AddOffersToArchiveRequest | 

try:
    # Добавление товаров в архив
    api_response = api_instance.add_offers_to_archive(businessId, addOffersToArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->addOffersToArchive: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let addOffersToArchiveRequest = ; // AddOffersToArchiveRequest

    let mut context = FbsApi::Context::default();
    let result = client.addOffersToArchive(businessId, addOffersToArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addOffersToArchiveRequest *

Responses


calculateTariffs

Калькулятор стоимости услуг

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги. Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг. В запросе можно указать либо параметр `campaignId`, либо `sellingProgram`. Совместное использование параметров приведет к ошибке. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/tariffs/calculate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/tariffs/calculate" \
 -d '{
  "offers" : [ {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  } ],
  "parameters" : {
    "campaignId" : 0,
    "sellingProgram" : "FBY",
    "frequency" : "DAILY"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CalculateTariffsRequest calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

try {
    final result = await api_instance.calculateTariffs(calculateTariffsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->calculateTariffs: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
CalculateTariffsRequest *calculateTariffsRequest = ; // 

// Калькулятор стоимости услуг
[apiInstance calculateTariffsWith:calculateTariffsRequest
              completionHandler: ^(CalculateTariffsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var calculateTariffsRequest = ; // {CalculateTariffsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateTariffs(calculateTariffsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class calculateTariffsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

            try {
                // Калькулятор стоимости услуг
                CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.calculateTariffs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$calculateTariffsRequest = ; // CalculateTariffsRequest | 

try {
    $result = $api_instance->calculateTariffs($calculateTariffsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->calculateTariffs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $calculateTariffsRequest = WWW::OPenAPIClient::Object::CalculateTariffsRequest->new(); # CalculateTariffsRequest | 

eval {
    my $result = $api_instance->calculateTariffs(calculateTariffsRequest => $calculateTariffsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->calculateTariffs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
calculateTariffsRequest =  # CalculateTariffsRequest | 

try:
    # Калькулятор стоимости услуг
    api_response = api_instance.calculate_tariffs(calculateTariffsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->calculateTariffs: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let calculateTariffsRequest = ; // CalculateTariffsRequest

    let mut context = FbsApi::Context::default();
    let result = client.calculateTariffs(calculateTariffsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
calculateTariffsRequest *

Responses


confirmBusinessPrices

Удаление товара из карантина по цене в кабинете

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина. Основная цена задается в каталоге и действует во всех магазинах кабинета. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST businesses/{businessId}/price-quarantine](getBusinessQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmBusinessPrices(businessId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmBusinessPrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в кабинете
[apiInstance confirmBusinessPricesWith:businessId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmBusinessPrices(businessId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в кабинете
                EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.confirmBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmBusinessPrices($businessId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->confirmBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmBusinessPrices(businessId => $businessId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->confirmBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в кабинете
    api_response = api_instance.confirm_business_prices(businessId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->confirmBusinessPrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = FbsApi::Context::default();
    let result = client.confirmBusinessPrices(businessId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmCampaignPrices

Удаление товара из карантина по цене в магазине

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST campaigns/{campaignId}/price-quarantine](getCampaignQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmCampaignPrices(campaignId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmCampaignPrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в магазине
[apiInstance confirmCampaignPricesWith:campaignId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmCampaignPrices(campaignId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmCampaignPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в магазине
                EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.confirmCampaignPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmCampaignPrices($campaignId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->confirmCampaignPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmCampaignPrices(campaignId => $campaignId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->confirmCampaignPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в магазине
    api_response = api_instance.confirm_campaign_prices(campaignId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->confirmCampaignPrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = FbsApi::Context::default();
    let result = client.confirmCampaignPrices(campaignId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmShipment

Подтверждение отгрузки

Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm" \
 -d '{
  "externalShipmentId" : "externalShipmentId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ConfirmShipmentRequest confirmShipmentRequest = ; // ConfirmShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final ConfirmShipmentRequest confirmShipmentRequest = new ConfirmShipmentRequest(); // ConfirmShipmentRequest | 

try {
    final result = await api_instance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmShipment: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ConfirmShipmentRequest confirmShipmentRequest = ; // ConfirmShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#confirmShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
ConfirmShipmentRequest *confirmShipmentRequest = ; //  (optional)

// Подтверждение отгрузки
[apiInstance confirmShipmentWith:campaignId
    shipmentId:shipmentId
    confirmShipmentRequest:confirmShipmentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'confirmShipmentRequest':  // {ConfirmShipmentRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmShipment(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var confirmShipmentRequest = new ConfirmShipmentRequest(); // ConfirmShipmentRequest |  (optional) 

            try {
                // Подтверждение отгрузки
                EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.confirmShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$confirmShipmentRequest = ; // ConfirmShipmentRequest | 

try {
    $result = $api_instance->confirmShipment($campaignId, $shipmentId, $confirmShipmentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->confirmShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $confirmShipmentRequest = WWW::OPenAPIClient::Object::ConfirmShipmentRequest->new(); # ConfirmShipmentRequest | 

eval {
    my $result = $api_instance->confirmShipment(campaignId => $campaignId, shipmentId => $shipmentId, confirmShipmentRequest => $confirmShipmentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->confirmShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
confirmShipmentRequest =  # ConfirmShipmentRequest |  (optional)

try:
    # Подтверждение отгрузки
    api_response = api_instance.confirm_shipment(campaignId, shipmentId, confirmShipmentRequest=confirmShipmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->confirmShipment: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let confirmShipmentRequest = ; // ConfirmShipmentRequest

    let mut context = FbsApi::Context::default();
    let result = client.confirmShipment(campaignId, shipmentId, confirmShipmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
confirmShipmentRequest

Responses


createChat

Создание нового чата с покупателем

Создает новый чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/new

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/new" \
 -d '{
  "orderId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#createChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final CreateChatRequest createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

try {
    final result = await api_instance.createChat(businessId, createChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createChat: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#createChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
CreateChatRequest *createChatRequest = ; // 

// Создание нового чата с покупателем
[apiInstance createChatWith:businessId
    createChatRequest:createChatRequest
              completionHandler: ^(CreateChatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var createChatRequest = ; // {CreateChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChat(businessId, createChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

            try {
                // Создание нового чата с покупателем
                CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.createChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$createChatRequest = ; // CreateChatRequest | 

try {
    $result = $api_instance->createChat($businessId, $createChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->createChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $createChatRequest = WWW::OPenAPIClient::Object::CreateChatRequest->new(); # CreateChatRequest | 

eval {
    my $result = $api_instance->createChat(businessId => $businessId, createChatRequest => $createChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->createChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
createChatRequest =  # CreateChatRequest | 

try:
    # Создание нового чата с покупателем
    api_response = api_instance.create_chat(businessId, createChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->createChat: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let createChatRequest = ; // CreateChatRequest

    let mut context = FbsApi::Context::default();
    let result = client.createChat(businessId, createChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
createChatRequest *

description

Responses


deleteCampaignOffers

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteCampaignOffersRequest deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

try {
    final result = await api_instance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteCampaignOffersRequest *deleteCampaignOffersRequest = ; // 

// Удаление товаров из ассортимента магазина
[apiInstance deleteCampaignOffersWith:campaignId
    deleteCampaignOffersRequest:deleteCampaignOffersRequest
              completionHandler: ^(DeleteCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteCampaignOffersRequest = ; // {DeleteCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

            try {
                // Удаление товаров из ассортимента магазина
                DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deleteCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

try {
    $result = $api_instance->deleteCampaignOffers($campaignId, $deleteCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deleteCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteCampaignOffersRequest = WWW::OPenAPIClient::Object::DeleteCampaignOffersRequest->new(); # DeleteCampaignOffersRequest | 

eval {
    my $result = $api_instance->deleteCampaignOffers(campaignId => $campaignId, deleteCampaignOffersRequest => $deleteCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deleteCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteCampaignOffersRequest =  # DeleteCampaignOffersRequest | 

try:
    # Удаление товаров из ассортимента магазина
    api_response = api_instance.delete_campaign_offers(campaignId, deleteCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deleteCampaignOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteCampaignOffersRequest *

Responses


deleteGoodsFeedbackComment

Удаление комментария к отзыву

Удаляет комментарий магазина. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/delete" \
 -d '{
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteGoodsFeedbackCommentRequest *deleteGoodsFeedbackCommentRequest = ; // 

// Удаление комментария к отзыву
[apiInstance deleteGoodsFeedbackCommentWith:businessId
    deleteGoodsFeedbackCommentRequest:deleteGoodsFeedbackCommentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteGoodsFeedbackCommentRequest = ; // {DeleteGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

            try {
                // Удаление комментария к отзыву
                EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deleteGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->deleteGoodsFeedbackComment($businessId, $deleteGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deleteGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::DeleteGoodsFeedbackCommentRequest->new(); # DeleteGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->deleteGoodsFeedbackComment(businessId => $businessId, deleteGoodsFeedbackCommentRequest => $deleteGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deleteGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteGoodsFeedbackCommentRequest =  # DeleteGoodsFeedbackCommentRequest | 

try:
    # Удаление комментария к отзыву
    api_response = api_instance.delete_goods_feedback_comment(businessId, deleteGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deleteGoodsFeedbackComment: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest

    let mut context = FbsApi::Context::default();
    let result = client.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteGoodsFeedbackCommentRequest *

Responses


deleteHiddenOffers

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers/delete" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteHiddenOffersRequest deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

try {
    final result = await api_instance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteHiddenOffersRequest *deleteHiddenOffersRequest = ; // 

// Возобновление показа товаров
[apiInstance deleteHiddenOffersWith:campaignId
    deleteHiddenOffersRequest:deleteHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteHiddenOffersRequest = ; // {DeleteHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

            try {
                // Возобновление показа товаров
                EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deleteHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

try {
    $result = $api_instance->deleteHiddenOffers($campaignId, $deleteHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deleteHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteHiddenOffersRequest = WWW::OPenAPIClient::Object::DeleteHiddenOffersRequest->new(); # DeleteHiddenOffersRequest | 

eval {
    my $result = $api_instance->deleteHiddenOffers(campaignId => $campaignId, deleteHiddenOffersRequest => $deleteHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deleteHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteHiddenOffersRequest =  # DeleteHiddenOffersRequest | 

try:
    # Возобновление показа товаров
    api_response = api_instance.delete_hidden_offers(campaignId, deleteHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deleteHiddenOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteHiddenOffersRequest *

Запрос на возобновление показа оферов.

Responses


deleteOffers

Удаление товаров из каталога

Удаляет товары из каталога. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersRequest deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

try {
    final result = await api_instance.deleteOffers(businessId, deleteOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersRequest *deleteOffersRequest = ; // 

// Удаление товаров из каталога
[apiInstance deleteOffersWith:businessId
    deleteOffersRequest:deleteOffersRequest
              completionHandler: ^(DeleteOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersRequest = ; // {DeleteOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffers(businessId, deleteOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

            try {
                // Удаление товаров из каталога
                DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deleteOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersRequest = ; // DeleteOffersRequest | 

try {
    $result = $api_instance->deleteOffers($businessId, $deleteOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deleteOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersRequest = WWW::OPenAPIClient::Object::DeleteOffersRequest->new(); # DeleteOffersRequest | 

eval {
    my $result = $api_instance->deleteOffers(businessId => $businessId, deleteOffersRequest => $deleteOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deleteOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersRequest =  # DeleteOffersRequest | 

try:
    # Удаление товаров из каталога
    api_response = api_instance.delete_offers(businessId, deleteOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deleteOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersRequest = ; // DeleteOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.deleteOffers(businessId, deleteOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersRequest *

Responses


deleteOffersFromArchive

Удаление товаров из архива

Восстанавливает товары из архива. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/unarchive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/unarchive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

try {
    final result = await api_instance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffersFromArchive: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersFromArchiveRequest *deleteOffersFromArchiveRequest = ; // 

// Удаление товаров из архива
[apiInstance deleteOffersFromArchiveWith:businessId
    deleteOffersFromArchiveRequest:deleteOffersFromArchiveRequest
              completionHandler: ^(DeleteOffersFromArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersFromArchiveRequest = ; // {DeleteOffersFromArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersFromArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

            try {
                // Удаление товаров из архива
                DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deleteOffersFromArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

try {
    $result = $api_instance->deleteOffersFromArchive($businessId, $deleteOffersFromArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deleteOffersFromArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersFromArchiveRequest = WWW::OPenAPIClient::Object::DeleteOffersFromArchiveRequest->new(); # DeleteOffersFromArchiveRequest | 

eval {
    my $result = $api_instance->deleteOffersFromArchive(businessId => $businessId, deleteOffersFromArchiveRequest => $deleteOffersFromArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deleteOffersFromArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersFromArchiveRequest =  # DeleteOffersFromArchiveRequest | 

try:
    # Удаление товаров из архива
    api_response = api_instance.delete_offers_from_archive(businessId, deleteOffersFromArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deleteOffersFromArchive: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest

    let mut context = FbsApi::Context::default();
    let result = client.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersFromArchiveRequest *

Responses


deletePromoOffers

Удаление товаров из акции

Убирает товары из акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete" \
 -d '{
  "deleteAllOffers" : true,
  "promoId" : "promoId",
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeletePromoOffersRequest deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

try {
    final result = await api_instance.deletePromoOffers(businessId, deletePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePromoOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeletePromoOffersRequest *deletePromoOffersRequest = ; // 

// Удаление товаров из акции
[apiInstance deletePromoOffersWith:businessId
    deletePromoOffersRequest:deletePromoOffersRequest
              completionHandler: ^(DeletePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deletePromoOffersRequest = ; // {DeletePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePromoOffers(businessId, deletePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deletePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

            try {
                // Удаление товаров из акции
                DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.deletePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

try {
    $result = $api_instance->deletePromoOffers($businessId, $deletePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->deletePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deletePromoOffersRequest = WWW::OPenAPIClient::Object::DeletePromoOffersRequest->new(); # DeletePromoOffersRequest | 

eval {
    my $result = $api_instance->deletePromoOffers(businessId => $businessId, deletePromoOffersRequest => $deletePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->deletePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deletePromoOffersRequest =  # DeletePromoOffersRequest | 

try:
    # Удаление товаров из акции
    api_response = api_instance.delete_promo_offers(businessId, deletePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->deletePromoOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let deletePromoOffersRequest = ; // DeletePromoOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.deletePromoOffers(businessId, deletePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deletePromoOffersRequest *

Responses


downloadShipmentAct

Получение акта приема-передачи

{% note warning "Экспресс‑доставка" %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно. {% endnote %} Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | **Данные в акте** | **Описание** | | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Дата | Дата запроса. | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос [POST order/accept](../../pushapi/reference/orderAccept.md) от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentAct: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение акта приема-передачи
[apiInstance downloadShipmentActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение акта приема-передачи
                File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение акта приема-передачи
    api_response = api_instance.download_shipment_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentAct: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentDiscrepancyAct

Получение акта расхождений

Возвращает акт расхождений для заданной отгрузки. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.ms-excel,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentDiscrepancyAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentDiscrepancyAct: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentDiscrepancyAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение акта расхождений
[apiInstance downloadShipmentDiscrepancyActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentDiscrepancyAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentDiscrepancyActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение акта расхождений
                File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentDiscrepancyAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentDiscrepancyAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentDiscrepancyAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentDiscrepancyAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentDiscrepancyAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение акта расхождений
    api_response = api_instance.download_shipment_discrepancy_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentDiscrepancyAct: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentDiscrepancyAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentInboundAct

Получение фактического акта приема-передачи

Возвращает фактический акт приема-передачи для заданной отгрузки. Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentInboundAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentInboundAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentInboundAct: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentInboundAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение фактического акта приема-передачи
[apiInstance downloadShipmentInboundActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentInboundAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentInboundActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение фактического акта приема-передачи
                File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentInboundAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentInboundAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentInboundAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentInboundAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentInboundAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение фактического акта приема-передачи
    api_response = api_instance.download_shipment_inbound_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentInboundAct: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentInboundAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentPalletLabels

Ярлыки для доверительной приемки (FBS)

PDF-файл с ярлыками на каждый короб или палету в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в [Справке Маркета](https://yandex.ru/support/marketplace/orders/fbs/process.html#acceptance). Распечатайте по несколько копий каждого ярлыка: на одну тару нужно наклеить минимум 2 ярлыка с разных сторон. Количество упаковок в отгрузке задается в запросе [PUT campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets](../../reference/shipments/setShipmentPalletsCount.md). |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ShipmentPalletLabelPageFormatType format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


        try {
            File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentPalletLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final ShipmentPalletLabelPageFormatType format = new ShipmentPalletLabelPageFormatType(); // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


try {
    final result = await api_instance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentPalletLabels: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ShipmentPalletLabelPageFormatType format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


        try {
            File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentPalletLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
ShipmentPalletLabelPageFormatType *format = ; // Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional) (default to null)

// Ярлыки для доверительной приемки (FBS)
[apiInstance downloadShipmentPalletLabelsWith:campaignId
    shipmentId:shipmentId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'format':  // {ShipmentPalletLabelPageFormatType} Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentPalletLabels(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentPalletLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var format = new ShipmentPalletLabelPageFormatType(); // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional)  (default to null)

            try {
                // Ярлыки для доверительной приемки (FBS)
                File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentPalletLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


try {
    $result = $api_instance->downloadShipmentPalletLabels($campaignId, $shipmentId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentPalletLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $format = ; # ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


eval {
    my $result = $api_instance->downloadShipmentPalletLabels(campaignId => $campaignId, shipmentId => $shipmentId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentPalletLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
format =  # ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional) (default to null)

try:
    # Ярлыки для доверительной приемки (FBS)
    api_response = api_instance.download_shipment_pallet_labels(campaignId, shipmentId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentPalletLabels: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let format = ; // ShipmentPalletLabelPageFormatType

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentPalletLabels(campaignId, shipmentId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Query parameters
Name Description
format
ShipmentPalletLabelPageFormatType
Формат страниц PDF-файла с ярлыками: * `A4` — по 16 ярлыков на странице. * `A8` — по одному ярлыку на странице.

Responses


downloadShipmentReceptionTransferAct

Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее

Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF. {% note warning "Экспресс‑доставка" %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам [Яндекс Go](https://go.yandex/), подготавливать акт приема‑передачи не нужно. {% endnote %} В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | **Данные в акте** | **Описание** | | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос [POST order/accept](../../pushapi/reference/orderAccept.md) от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/shipments/reception-transfer-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/shipments/reception-transfer-act?warehouse_id=123123"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Integer warehouseId = 123123; // Integer | Идентификатор склада.

        try {
            File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentReceptionTransferAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Integer warehouseId = new Integer(); // Integer | Идентификатор склада.

try {
    final result = await api_instance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentReceptionTransferAct: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Integer warehouseId = 123123; // Integer | Идентификатор склада.

        try {
            File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentReceptionTransferAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Integer *warehouseId = 123123; // Идентификатор склада. (optional) (default to null)

// Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
[apiInstance downloadShipmentReceptionTransferActWith:campaignId
    warehouseId:warehouseId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'warehouseId': 123123 // {Integer} Идентификатор склада.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentReceptionTransferAct(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentReceptionTransferActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var warehouseId = 123123;  // Integer | Идентификатор склада. (optional)  (default to null)

            try {
                // Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
                File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentReceptionTransferAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$warehouseId = 123123; // Integer | Идентификатор склада.

try {
    $result = $api_instance->downloadShipmentReceptionTransferAct($campaignId, $warehouseId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentReceptionTransferAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $warehouseId = 123123; # Integer | Идентификатор склада.

eval {
    my $result = $api_instance->downloadShipmentReceptionTransferAct(campaignId => $campaignId, warehouseId => $warehouseId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentReceptionTransferAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
warehouseId = 123123 # Integer | Идентификатор склада. (optional) (default to null)

try:
    # Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
    api_response = api_instance.download_shipment_reception_transfer_act(campaignId, warehouseId=warehouseId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentReceptionTransferAct: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let warehouseId = 123123; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentReceptionTransferAct(campaignId, warehouseId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
warehouse_id
Integer (int32)
Идентификатор склада.

Responses


downloadShipmentTransportationWaybill

Получение транспортной накладной

Возвращает транспортную накладную для заданной отгрузки. Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. [Подробно об этом способе отгрузки](https://yandex.ru/support/marketplace/orders/fbs/settings/shipment.html#at-your-warehouse) |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.ms-excel,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentTransportationWaybill");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentTransportationWaybill: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#downloadShipmentTransportationWaybill");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение транспортной накладной
[apiInstance downloadShipmentTransportationWaybillWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentTransportationWaybill(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentTransportationWaybillExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение транспортной накладной
                File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.downloadShipmentTransportationWaybill: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentTransportationWaybill($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->downloadShipmentTransportationWaybill: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentTransportationWaybill(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->downloadShipmentTransportationWaybill: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение транспортной накладной
    api_response = api_instance.download_shipment_transportation_waybill(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->downloadShipmentTransportationWaybill: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.downloadShipmentTransportationWaybill(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


generateBoostConsolidatedReport

Отчет по бусту продаж

Запускает генерацию **сводного отчета по бусту продаж** за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/boost-consolidated/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/boost-consolidated/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBoostConsolidatedReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateBoostConsolidatedRequest *generateBoostConsolidatedRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по бусту продаж
[apiInstance generateBoostConsolidatedReportWith:generateBoostConsolidatedRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateBoostConsolidatedRequest = ; // {GenerateBoostConsolidatedRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateBoostConsolidatedReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по бусту продаж
                GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateBoostConsolidatedReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateBoostConsolidatedReport($generateBoostConsolidatedRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateBoostConsolidatedReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateBoostConsolidatedRequest = WWW::OPenAPIClient::Object::GenerateBoostConsolidatedRequest->new(); # GenerateBoostConsolidatedRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateBoostConsolidatedReport(generateBoostConsolidatedRequest => $generateBoostConsolidatedRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateBoostConsolidatedReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateBoostConsolidatedRequest =  # GenerateBoostConsolidatedRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по бусту продаж
    api_response = api_instance.generate_boost_consolidated_report(generateBoostConsolidatedRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateBoostConsolidatedReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateBoostConsolidatedRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateCompetitorsPositionReport

Отчет «Конкурентная позиция»

Запускает генерацию **отчета «Конкурентная позиция»** за заданный период. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/analytics/competitors.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). {% note info "Значение -1 в отчете" %} Если в CSV-файле в столбце **POSITION** стоит -1, в этот день не было заказов с товарами в указанной категории. {% endnote %} |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/competitors-position/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/competitors-position/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "categoryId" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateCompetitorsPositionReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateCompetitorsPositionReportRequest *generateCompetitorsPositionReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Конкурентная позиция»
[apiInstance generateCompetitorsPositionReportWith:generateCompetitorsPositionReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateCompetitorsPositionReportRequest = ; // {GenerateCompetitorsPositionReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateCompetitorsPositionReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Конкурентная позиция»
                GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateCompetitorsPositionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateCompetitorsPositionReport($generateCompetitorsPositionReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateCompetitorsPositionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateCompetitorsPositionReportRequest = WWW::OPenAPIClient::Object::GenerateCompetitorsPositionReportRequest->new(); # GenerateCompetitorsPositionReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest => $generateCompetitorsPositionReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateCompetitorsPositionReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateCompetitorsPositionReportRequest =  # GenerateCompetitorsPositionReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Конкурентная позиция»
    api_response = api_instance.generate_competitors_position_report(generateCompetitorsPositionReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateCompetitorsPositionReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateCompetitorsPositionReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsFeedbackReport

Отчет по отзывам о товарах

Запускает генерацию **отчета по отзывам о товарах**. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/marketing/plus-reviews#stat) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-feedback/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-feedback/generate?format=" \
 -d '{
  "businessId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsFeedbackReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateGoodsFeedbackRequest *generateGoodsFeedbackRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по отзывам о товарах
[apiInstance generateGoodsFeedbackReportWith:generateGoodsFeedbackRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateGoodsFeedbackRequest = ; // {GenerateGoodsFeedbackRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsFeedbackReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по отзывам о товарах
                GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateGoodsFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsFeedbackReport($generateGoodsFeedbackRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateGoodsFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GenerateGoodsFeedbackRequest->new(); # GenerateGoodsFeedbackRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsFeedbackReport(generateGoodsFeedbackRequest => $generateGoodsFeedbackRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateGoodsFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateGoodsFeedbackRequest =  # GenerateGoodsFeedbackRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по отзывам о товарах
    api_response = api_instance.generate_goods_feedback_report(generateGoodsFeedbackRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateGoodsFeedbackReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsFeedbackRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsRealizationReport

Отчет по реализации

Запускает генерацию **отчета по реализации** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#sales-report) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-realization/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-realization/generate?format=" \
 -d '{
  "month" : 2,
  "year" : 6,
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsRealizationReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateGoodsRealizationReportRequest *generateGoodsRealizationReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по реализации
[apiInstance generateGoodsRealizationReportWith:generateGoodsRealizationReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateGoodsRealizationReportRequest = ; // {GenerateGoodsRealizationReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsRealizationReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по реализации
                GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateGoodsRealizationReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsRealizationReport($generateGoodsRealizationReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateGoodsRealizationReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateGoodsRealizationReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsRealizationReportRequest->new(); # GenerateGoodsRealizationReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsRealizationReport(generateGoodsRealizationReportRequest => $generateGoodsRealizationReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateGoodsRealizationReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateGoodsRealizationReportRequest =  # GenerateGoodsRealizationReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по реализации
    api_response = api_instance.generate_goods_realization_report(generateGoodsRealizationReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateGoodsRealizationReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsRealizationReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateMassOrderLabelsReport

Готовые ярлыки‑наклейки на все коробки в нескольких заказах

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 1000 запросов в час| |-|


/reports/documents/labels/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/labels/generate?format=" \
 -d '{
  "businessId" : 0,
  "orderIds" : [ 6, 6, 6, 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    final result = await api_instance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateMassOrderLabelsReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateMassOrderLabelsRequest *generateMassOrderLabelsRequest = ; // 
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в нескольких заказах
[apiInstance generateMassOrderLabelsReportWith:generateMassOrderLabelsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateMassOrderLabelsRequest = ; // {GenerateMassOrderLabelsRequest} 
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateMassOrderLabelsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в нескольких заказах
                GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateMassOrderLabelsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    $result = $api_instance->generateMassOrderLabelsReport($generateMassOrderLabelsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateMassOrderLabelsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateMassOrderLabelsRequest = WWW::OPenAPIClient::Object::GenerateMassOrderLabelsRequest->new(); # GenerateMassOrderLabelsRequest | 
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

eval {
    my $result = $api_instance->generateMassOrderLabelsReport(generateMassOrderLabelsRequest => $generateMassOrderLabelsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateMassOrderLabelsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateMassOrderLabelsRequest =  # GenerateMassOrderLabelsRequest | 
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в нескольких заказах
    api_response = api_instance.generate_mass_order_labels_report(generateMassOrderLabelsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateMassOrderLabelsReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest
    let format = ; // PageFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateMassOrderLabelsRequest *

Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Responses


generateOrderLabel

Готовый ярлык‑наклейка для коробки в заказе

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Идентификатор грузоместа.
final Long boxId = new Long(); // Long | Идентификатор коробки.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabel: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Идентификатор грузоместа. (default to null)
Long *boxId = 789; // Идентификатор коробки. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовый ярлык‑наклейка для коробки в заказе
[apiInstance generateOrderLabelWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    boxId:boxId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Идентификатор грузоместа.
var boxId = 789; // {Long} Идентификатор коробки.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabel(campaignId, orderId, shipmentId, boxId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Идентификатор грузоместа. (default to null)
            var boxId = 789;  // Long | Идентификатор коробки. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовый ярлык‑наклейка для коробки в заказе
                File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateOrderLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Идентификатор грузоместа.
$boxId = 789; // Long | Идентификатор коробки.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabel($campaignId, $orderId, $shipmentId, $boxId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateOrderLabel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Идентификатор грузоместа.
my $boxId = 789; # Long | Идентификатор коробки.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabel(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, boxId => $boxId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateOrderLabel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Идентификатор грузоместа. (default to null)
boxId = 789 # Long | Идентификатор коробки. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовый ярлык‑наклейка для коробки в заказе
    api_response = api_instance.generate_order_label(campaignId, orderId, shipmentId, boxId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateOrderLabel: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let boxId = 789; // Long
    let format = ; // PageFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Идентификатор грузоместа.
Required
boxId*
Long (int64)
Идентификатор коробки.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generateOrderLabels

Готовые ярлыки‑наклейки на все коробки в одном заказе

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabels(campaignId, orderId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabels: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в одном заказе
[apiInstance generateOrderLabelsWith:campaignId
    orderId:orderId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabels(campaignId, orderId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в одном заказе
                File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateOrderLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabels($campaignId, $orderId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateOrderLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabels(campaignId => $campaignId, orderId => $orderId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateOrderLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в одном заказе
    api_response = api_instance.generate_order_labels(campaignId, orderId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateOrderLabels: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let format = ; // PageFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateOrderLabels(campaignId, orderId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generatePricesReport

Отчет «Цены на рынке»

Запускает генерацию **отчета «Цены на рынке»**. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/prices/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/prices/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "creationDateTo" : "2000-01-23",
  "campaignId" : 6,
  "businessId" : 0,
  "creationDateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GeneratePricesReportRequest generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generatePricesReport(generatePricesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generatePricesReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GeneratePricesReportRequest *generatePricesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Цены на рынке»
[apiInstance generatePricesReportWith:generatePricesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generatePricesReportRequest = ; // {GeneratePricesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generatePricesReport(generatePricesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generatePricesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Цены на рынке»
                GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generatePricesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generatePricesReportRequest = ; // GeneratePricesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generatePricesReport($generatePricesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generatePricesReportRequest = WWW::OPenAPIClient::Object::GeneratePricesReportRequest->new(); # GeneratePricesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generatePricesReport(generatePricesReportRequest => $generatePricesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generatePricesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generatePricesReportRequest =  # GeneratePricesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Цены на рынке»
    api_response = api_instance.generate_prices_report(generatePricesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generatePricesReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generatePricesReportRequest = ; // GeneratePricesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generatePricesReport(generatePricesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generatePricesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShelfsStatisticsReport

Отчет по полкам

Запускает генерацию **сводного отчета по полкам** — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf). Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/shelf-statistics/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shelf-statistics/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "attributionType" : "CLICKS"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShelfsStatisticsReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateShelfsStatisticsRequest *generateShelfsStatisticsRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по полкам
[apiInstance generateShelfsStatisticsReportWith:generateShelfsStatisticsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateShelfsStatisticsRequest = ; // {GenerateShelfsStatisticsRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShelfsStatisticsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по полкам
                GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateShelfsStatisticsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShelfsStatisticsReport($generateShelfsStatisticsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateShelfsStatisticsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateShelfsStatisticsRequest = WWW::OPenAPIClient::Object::GenerateShelfsStatisticsRequest->new(); # GenerateShelfsStatisticsRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShelfsStatisticsReport(generateShelfsStatisticsRequest => $generateShelfsStatisticsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateShelfsStatisticsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateShelfsStatisticsRequest =  # GenerateShelfsStatisticsRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по полкам
    api_response = api_instance.generate_shelfs_statistics_report(generateShelfsStatisticsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateShelfsStatisticsReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShelfsStatisticsRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShipmentListDocumentReport

Получение листа сборки

Запускает генерацию **листа сборки** для отгрузки. Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/documents/shipment-list/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/shipment-list/generate" \
 -d '{
  "campaignId" : 0,
  "shipmentId" : 6,
  "orderIds" : [ 1, 1 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

        try {
            GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShipmentListDocumentReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = new GenerateShipmentListDocumentReportRequest(); // GenerateShipmentListDocumentReportRequest | 

try {
    final result = await api_instance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShipmentListDocumentReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

        try {
            GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShipmentListDocumentReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateShipmentListDocumentReportRequest *generateShipmentListDocumentReportRequest = ; // 

// Получение листа сборки
[apiInstance generateShipmentListDocumentReportWith:generateShipmentListDocumentReportRequest
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateShipmentListDocumentReportRequest = ; // {GenerateShipmentListDocumentReportRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShipmentListDocumentReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateShipmentListDocumentReportRequest = new GenerateShipmentListDocumentReportRequest(); // GenerateShipmentListDocumentReportRequest | 

            try {
                // Получение листа сборки
                GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateShipmentListDocumentReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

try {
    $result = $api_instance->generateShipmentListDocumentReport($generateShipmentListDocumentReportRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateShipmentListDocumentReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateShipmentListDocumentReportRequest = WWW::OPenAPIClient::Object::GenerateShipmentListDocumentReportRequest->new(); # GenerateShipmentListDocumentReportRequest | 

eval {
    my $result = $api_instance->generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest => $generateShipmentListDocumentReportRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateShipmentListDocumentReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateShipmentListDocumentReportRequest =  # GenerateShipmentListDocumentReportRequest | 

try:
    # Получение листа сборки
    api_response = api_instance.generate_shipment_list_document_report(generateShipmentListDocumentReportRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateShipmentListDocumentReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest

    let mut context = FbsApi::Context::default();
    let result = client.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShipmentListDocumentReportRequest *

Responses


generateShowsSalesReport

Отчет «Аналитика продаж»

Запускает генерацию **отчета «Аналитика продаж»** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/shows-sales.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/shows-sales/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=" \
 -d '{
  "campaignId" : 6,
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "grouping" : "CATEGORIES"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShowsSalesReportRequest generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShowsSalesReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateShowsSalesReportRequest *generateShowsSalesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Аналитика продаж»
[apiInstance generateShowsSalesReportWith:generateShowsSalesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateShowsSalesReportRequest = ; // {GenerateShowsSalesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShowsSalesReport(generateShowsSalesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShowsSalesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Аналитика продаж»
                GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateShowsSalesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShowsSalesReport($generateShowsSalesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateShowsSalesReportRequest = WWW::OPenAPIClient::Object::GenerateShowsSalesReportRequest->new(); # GenerateShowsSalesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShowsSalesReport(generateShowsSalesReportRequest => $generateShowsSalesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateShowsSalesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateShowsSalesReportRequest =  # GenerateShowsSalesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Аналитика продаж»
    api_response = api_instance.generate_shows_sales_report(generateShowsSalesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateShowsSalesReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateShowsSalesReport(generateShowsSalesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShowsSalesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateStocksOnWarehousesReport

Отчет по остаткам на складах

Запускает генерацию **отчета по остаткам на складах**. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. * Для остальных моделей — об остатках на соответствующем складе магазина. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/stocks-on-warehouses/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "hasStocks" : true,
  "reportDate" : "2000-01-23",
  "campaignId" : 0,
  "warehouseIds" : [ 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateStocksOnWarehousesReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateStocksOnWarehousesReportRequest *generateStocksOnWarehousesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по остаткам на складах
[apiInstance generateStocksOnWarehousesReportWith:generateStocksOnWarehousesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateStocksOnWarehousesReportRequest = ; // {GenerateStocksOnWarehousesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateStocksOnWarehousesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по остаткам на складах
                GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateStocksOnWarehousesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateStocksOnWarehousesReport($generateStocksOnWarehousesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateStocksOnWarehousesReportRequest = WWW::OPenAPIClient::Object::GenerateStocksOnWarehousesReportRequest->new(); # GenerateStocksOnWarehousesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest => $generateStocksOnWarehousesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateStocksOnWarehousesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateStocksOnWarehousesReportRequest =  # GenerateStocksOnWarehousesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по остаткам на складах
    api_response = api_instance.generate_stocks_on_warehouses_report(generateStocksOnWarehousesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateStocksOnWarehousesReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateStocksOnWarehousesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedMarketplaceServicesReport

Отчет по стоимости услуг

Запускает генерацию **отчета по стоимости услуг** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports.html) Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-----------------------------|---------------------------------| |По дате начисления услуги |`dateFrom` и `dateTo` | |По дате формирования акта |`year` и `month` | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-marketplace-services/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-marketplace-services/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "yearFrom" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "monthFrom" : 2,
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 2, 2 ],
  "dateFrom" : "2000-01-23",
  "monthTo" : 7,
  "yearTo" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedMarketplaceServicesReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateUnitedMarketplaceServicesReportRequest *generateUnitedMarketplaceServicesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по стоимости услуг
[apiInstance generateUnitedMarketplaceServicesReportWith:generateUnitedMarketplaceServicesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateUnitedMarketplaceServicesReportRequest = ; // {GenerateUnitedMarketplaceServicesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedMarketplaceServicesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по стоимости услуг
                GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateUnitedMarketplaceServicesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedMarketplaceServicesReport($generateUnitedMarketplaceServicesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateUnitedMarketplaceServicesReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedMarketplaceServicesReportRequest->new(); # GenerateUnitedMarketplaceServicesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest => $generateUnitedMarketplaceServicesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateUnitedMarketplaceServicesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateUnitedMarketplaceServicesReportRequest =  # GenerateUnitedMarketplaceServicesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по стоимости услуг
    api_response = api_instance.generate_united_marketplace_services_report(generateUnitedMarketplaceServicesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateUnitedMarketplaceServicesReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedMarketplaceServicesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedNettingReport

Отчет по платежам

Запускает генерацию **отчета по платежам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/transactions.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-------------------------|---------------------------------------| |О платежах за период |`dateFrom` и `dateTo` | |О платежном поручении |`bankOrderId` и `bankOrderDateTime` | Заказать отчеты обоих типов одним запросом нельзя. |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-netting/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-netting/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "bankOrderId" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 1, 1 ],
  "dateFrom" : "2000-01-23",
  "bankOrderDateTime" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedNettingReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateUnitedNettingReportRequest *generateUnitedNettingReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по платежам
[apiInstance generateUnitedNettingReportWith:generateUnitedNettingReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateUnitedNettingReportRequest = ; // {GenerateUnitedNettingReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedNettingReport(generateUnitedNettingReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedNettingReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по платежам
                GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateUnitedNettingReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedNettingReport($generateUnitedNettingReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateUnitedNettingReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedNettingReportRequest->new(); # GenerateUnitedNettingReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedNettingReport(generateUnitedNettingReportRequest => $generateUnitedNettingReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateUnitedNettingReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateUnitedNettingReportRequest =  # GenerateUnitedNettingReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по платежам
    api_response = api_instance.generate_united_netting_report(generateUnitedNettingReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateUnitedNettingReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateUnitedNettingReport(generateUnitedNettingReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedNettingReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedOrdersReport

Отчет по заказам

Запускает генерацию **отчета по заказам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/orders.html) {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. [Как получить детальную информацию по заказам](../../reference/stats/getOrdersStats.md) {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-orders/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-orders/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 6, 6 ],
  "promoId" : "promoId",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedOrdersRequest generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedOrdersReport: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GenerateUnitedOrdersRequest *generateUnitedOrdersRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по заказам
[apiInstance generateUnitedOrdersReportWith:generateUnitedOrdersRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var generateUnitedOrdersRequest = ; // {GenerateUnitedOrdersRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedOrdersReport(generateUnitedOrdersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedOrdersReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по заказам
                GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.generateUnitedOrdersReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedOrdersReport($generateUnitedOrdersRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $generateUnitedOrdersRequest = WWW::OPenAPIClient::Object::GenerateUnitedOrdersRequest->new(); # GenerateUnitedOrdersRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedOrdersReport(generateUnitedOrdersRequest => $generateUnitedOrdersRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->generateUnitedOrdersReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
generateUnitedOrdersRequest =  # GenerateUnitedOrdersRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по заказам
    api_response = api_instance.generate_united_orders_report(generateUnitedOrdersRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->generateUnitedOrdersReport: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest
    let format = ; // ReportFormatType

    let mut context = FbsApi::Context::default();
    let result = client.generateUnitedOrdersReport(generateUnitedOrdersRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedOrdersRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


getAllOffers

Все предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers/all

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/all?feedId=789&chunk=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer chunk = new Integer(); // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    final result = await api_instance.getAllOffers(campaignId, feedId, chunk);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
Integer *chunk = 56; // Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

// Все предложения магазина
[apiInstance getAllOffersWith:campaignId
    feedId:feedId
    chunk:chunk
              completionHandler: ^(GetAllOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'chunk': 56 // {Integer} Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getAllOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var chunk = 56;  // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional)  (default to null)

            try {
                // Все предложения магазина
                GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getAllOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    $result = $api_instance->getAllOffers($campaignId, $feedId, $chunk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getAllOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $chunk = 56; # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


eval {
    my $result = $api_instance->getAllOffers(campaignId => $campaignId, feedId => $feedId, chunk => $chunk);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getAllOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
chunk = 56 # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

try:
    # Все предложения магазина
    api_response = api_instance.get_all_offers(campaignId, feedId=feedId, chunk=chunk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getAllOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let chunk = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getAllOffers(campaignId, feedId, chunk, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
feedId
Long (int64)
Идентификатор прайс-листа.
chunk
Integer (int32)
Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}

Responses


getBidsInfoForBusiness

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/info

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | 

try {
    final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; //  (optional)

// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
    pageToken:pageToken
    limit:limit
    getBidsInfoRequest:getBidsInfoRequest
              completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getBidsInfoRequest':  // {GetBidsInfoRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsInfoForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |  (optional) 

            try {
                // Информация об установленных ставках
                GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getBidsInfoForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getBidsInfoRequest = ; // GetBidsInfoRequest | 

try {
    $result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest | 

eval {
    my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getBidsInfoRequest =  # GetBidsInfoRequest |  (optional)

try:
    # Информация об установленных ставках
    api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getBidsInfoForBusiness: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getBidsInfoRequest = ; // GetBidsInfoRequest

    let mut context = FbsApi::Context::default();
    let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsInfoRequest

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBidsRecommendations

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetBidsRecommendationsRequest getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

try {
    final result = await api_instance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsRecommendations: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetBidsRecommendationsRequest *getBidsRecommendationsRequest = ; // 

// Рекомендованные ставки для заданных товаров
[apiInstance getBidsRecommendationsWith:businessId
    getBidsRecommendationsRequest:getBidsRecommendationsRequest
              completionHandler: ^(GetBidsRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getBidsRecommendationsRequest = ; // {GetBidsRecommendationsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsRecommendations(businessId, getBidsRecommendationsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

            try {
                // Рекомендованные ставки для заданных товаров
                GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getBidsRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

try {
    $result = $api_instance->getBidsRecommendations($businessId, $getBidsRecommendationsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getBidsRecommendationsRequest = WWW::OPenAPIClient::Object::GetBidsRecommendationsRequest->new(); # GetBidsRecommendationsRequest | 

eval {
    my $result = $api_instance->getBidsRecommendations(businessId => $businessId, getBidsRecommendationsRequest => $getBidsRecommendationsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getBidsRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getBidsRecommendationsRequest =  # GetBidsRecommendationsRequest | 

try:
    # Рекомендованные ставки для заданных товаров
    api_response = api_instance.get_bids_recommendations(businessId, getBidsRecommendationsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getBidsRecommendations: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getBidsRecommendations(businessId, getBidsRecommendationsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsRecommendationsRequest *

description.

Responses


getBusinessQuarantineOffers

Список товаров, находящихся в карантине по цене в кабинете

Возвращает список товаров, которые находятся в карантине по **основной цене**. Основная цена задается в каталоге и действует во всех магазинах кабинета. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST businesses/{businessId}/price-quarantine/confirm](../../reference/business-assortment/confirmBusinessPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessQuarantineOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в кабинете
[apiInstance getBusinessQuarantineOffersWith:businessId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в кабинете
                GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getBusinessQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getBusinessQuarantineOffers($businessId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getBusinessQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getBusinessQuarantineOffers(businessId => $businessId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getBusinessQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в кабинете
    api_response = api_instance.get_business_quarantine_offers(businessId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getBusinessQuarantineOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBusinessSettings

Настройки кабинета

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/settings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getBusinessSettings(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessSettings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки кабинета
[apiInstance getBusinessSettingsWith:businessId
              completionHandler: ^(GetBusinessSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessSettings(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки кабинета
                GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getBusinessSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getBusinessSettings($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getBusinessSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getBusinessSettings(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getBusinessSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки кабинета
    api_response = api_instance.get_business_settings(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getBusinessSettings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getBusinessSettings(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaign

Информация о магазине

Возвращает информацию о магазине. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaign(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaign: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Информация о магазине
[apiInstance getCampaignWith:campaignId
              completionHandler: ^(GetCampaignResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Информация о магазине
                GetCampaignResponse result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Информация о магазине
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaign: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignLogins

Логины, связанные с магазином

Возвращает список логинов, у которых есть доступ к магазину. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/logins

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/logins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignLogins(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignLogins: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Логины, связанные с магазином
[apiInstance getCampaignLoginsWith:campaignId
              completionHandler: ^(GetCampaignLoginsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignLogins(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignLoginsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Логины, связанные с магазином
                GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignLogins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignLogins($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignLogins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignLogins(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignLogins: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Логины, связанные с магазином
    api_response = api_instance.get_campaign_logins(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignLogins: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignLogins(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignOffers

Информация о товарах, которые размещены в заданном магазине

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "statuses" : [ "PUBLISHED", "PUBLISHED" ],
  "offerIds" : [ null, null, null, null, null ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetCampaignOffersRequest getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetCampaignOffersRequest *getCampaignOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Информация о товарах, которые размещены в заданном магазине
[apiInstance getCampaignOffersWith:campaignId
    getCampaignOffersRequest:getCampaignOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getCampaignOffersRequest = ; // {GetCampaignOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignOffers(campaignId, getCampaignOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Информация о товарах, которые размещены в заданном магазине
                GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignOffers($campaignId, $getCampaignOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getCampaignOffersRequest = WWW::OPenAPIClient::Object::GetCampaignOffersRequest->new(); # GetCampaignOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignOffers(campaignId => $campaignId, getCampaignOffersRequest => $getCampaignOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getCampaignOffersRequest =  # GetCampaignOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Информация о товарах, которые размещены в заданном магазине
    api_response = api_instance.get_campaign_offers(campaignId, getCampaignOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getCampaignOffersRequest = ; // GetCampaignOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getCampaignOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignQuarantineOffers

Список товаров, находящихся в карантине по цене в магазине

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST campaigns/{campaignId}/price-quarantine/confirm](../../reference/assortment/confirmCampaignPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignQuarantineOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в магазине
[apiInstance getCampaignQuarantineOffersWith:campaignId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в магазине
                GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignQuarantineOffers($campaignId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignQuarantineOffers(campaignId => $campaignId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в магазине
    api_response = api_instance.get_campaign_quarantine_offers(campaignId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignQuarantineOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignRegion

Регион магазина

{% note warning "" %} Этот метод устарел. Вместо него используйте [GET campaigns/{campaignId}/settings](../../reference/campaigns/getCampaignSettings.md). {% endnote %} Возвращает регион, в котором находится магазин. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/campaigns/{campaignId}/region

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignRegion(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignRegion: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Регион магазина
[apiInstance getCampaignRegionWith:campaignId
              completionHandler: ^(GetCampaignRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignRegion(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignRegionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Регион магазина
                GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignRegion($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignRegion(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Регион магазина
    api_response = api_instance.get_campaign_region(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignRegion: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignRegion(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignSettings

Настройки магазина

Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/settings

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignSettings(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignSettings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки магазина
[apiInstance getCampaignSettingsWith:campaignId
              completionHandler: ^(GetCampaignSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignSettings(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки магазина
                GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignSettings($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignSettings(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки магазина
    api_response = api_instance.get_campaign_settings(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignSettings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignSettings(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaigns

Список магазинов пользователя

Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaigns(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaigns: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Список магазинов пользователя
[apiInstance getCampaignsWith:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaigns(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Список магазинов пользователя
                GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaigns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaigns($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaigns(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Список магазинов пользователя
    api_response = api_instance.get_campaigns(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaigns: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getCampaigns(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCampaignsByLogin

Магазины, доступные логину

Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/by_login/{login}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/by_login/{login}?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String login = new String(); // String | Логин пользователя.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaignsByLogin(login, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignsByLogin: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
String *login = login_example; // Логин пользователя. (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Магазины, доступные логину
[apiInstance getCampaignsByLoginWith:login
    page:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var login = login_example; // {String} Логин пользователя.
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignsByLogin(login, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsByLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var login = login_example;  // String | Логин пользователя. (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Магазины, доступные логину
                GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCampaignsByLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$login = login_example; // String | Логин пользователя.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaignsByLogin($login, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCampaignsByLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $login = login_example; # String | Логин пользователя.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaignsByLogin(login => $login, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCampaignsByLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
login = login_example # String | Логин пользователя. (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Магазины, доступные логину
    api_response = api_instance.get_campaigns_by_login(login, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCampaignsByLogin: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let login = login_example; // String
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getCampaignsByLogin(login, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
login*
String
Логин пользователя.
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCategoriesMaxSaleQuantum

Лимит на установку кванта продажи и минимального количества товаров в заказе

Возвращает лимит на установку [кванта](*quantum) и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий. Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины. Подробнее о том, как продавать товары по несколько штук, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/fields/quantum). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/max-sale-quantum

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/max-sale-quantum" \
 -d '{
  "marketCategoryIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

try {
    final result = await api_instance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesMaxSaleQuantum: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GetCategoriesMaxSaleQuantumRequest *getCategoriesMaxSaleQuantumRequest = ; // 

// Лимит на установку кванта продажи и минимального количества товаров в заказе
[apiInstance getCategoriesMaxSaleQuantumWith:getCategoriesMaxSaleQuantumRequest
              completionHandler: ^(GetCategoriesMaxSaleQuantumResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var getCategoriesMaxSaleQuantumRequest = ; // {GetCategoriesMaxSaleQuantumRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesMaxSaleQuantumExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

            try {
                // Лимит на установку кванта продажи и минимального количества товаров в заказе
                GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCategoriesMaxSaleQuantum: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

try {
    $result = $api_instance->getCategoriesMaxSaleQuantum($getCategoriesMaxSaleQuantumRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCategoriesMaxSaleQuantum: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $getCategoriesMaxSaleQuantumRequest = WWW::OPenAPIClient::Object::GetCategoriesMaxSaleQuantumRequest->new(); # GetCategoriesMaxSaleQuantumRequest | 

eval {
    my $result = $api_instance->getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest => $getCategoriesMaxSaleQuantumRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCategoriesMaxSaleQuantum: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
getCategoriesMaxSaleQuantumRequest =  # GetCategoriesMaxSaleQuantumRequest | 

try:
    # Лимит на установку кванта продажи и минимального количества товаров в заказе
    api_response = api_instance.get_categories_max_sale_quantum(getCategoriesMaxSaleQuantumRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCategoriesMaxSaleQuantum: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest

    let mut context = FbsApi::Context::default();
    let result = client.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesMaxSaleQuantumRequest *

Responses


getCategoriesTree

Дерево категорий

Возвращает дерево категорий Маркета. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/tree

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/tree" \
 -d '{
  "language" : "RU"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesRequest getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest | 

try {
    final result = await api_instance.getCategoriesTree(getCategoriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesTree: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
GetCategoriesRequest *getCategoriesRequest = ; //  (optional)

// Дерево категорий
[apiInstance getCategoriesTreeWith:getCategoriesRequest
              completionHandler: ^(GetCategoriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var opts = {
  'getCategoriesRequest':  // {GetCategoriesRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesTree(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesTreeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest |  (optional) 

            try {
                // Дерево категорий
                GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCategoriesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$getCategoriesRequest = ; // GetCategoriesRequest | 

try {
    $result = $api_instance->getCategoriesTree($getCategoriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCategoriesTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $getCategoriesRequest = WWW::OPenAPIClient::Object::GetCategoriesRequest->new(); # GetCategoriesRequest | 

eval {
    my $result = $api_instance->getCategoriesTree(getCategoriesRequest => $getCategoriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCategoriesTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
getCategoriesRequest =  # GetCategoriesRequest |  (optional)

try:
    # Дерево категорий
    api_response = api_instance.get_categories_tree(getCategoriesRequest=getCategoriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCategoriesTree: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let getCategoriesRequest = ; // GetCategoriesRequest

    let mut context = FbsApi::Context::default();
    let result = client.getCategoriesTree(getCategoriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesRequest

Responses


getCategoryContentParameters

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |**⚙️ Лимит:** 50 категорий в минуту | |-|


/category/{categoryId}/parameters

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/category/{categoryId}/parameters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long categoryId = new Long(); // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    final result = await api_instance.getCategoryContentParameters(categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryContentParameters: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *categoryId = 789; // Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

// Списки характеристик товаров по категориям
[apiInstance getCategoryContentParametersWith:categoryId
              completionHandler: ^(GetCategoryContentParametersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var categoryId = 789; // {Long} Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryContentParameters(categoryId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoryContentParametersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var categoryId = 789;  // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

            try {
                // Списки характеристик товаров по категориям
                GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getCategoryContentParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    $result = $api_instance->getCategoryContentParameters($categoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getCategoryContentParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $categoryId = 789; # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


eval {
    my $result = $api_instance->getCategoryContentParameters(categoryId => $categoryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getCategoryContentParameters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
categoryId = 789 # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

try:
    # Списки характеристик товаров по категориям
    api_response = api_instance.get_category_content_parameters(categoryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getCategoryContentParameters: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let categoryId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getCategoryContentParameters(categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
categoryId*
Long (int64)
Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
Required

Responses


getChatHistory

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history?chatId=789&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "messageIdFrom" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final GetChatHistoryRequest getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChatHistory: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
GetChatHistoryRequest *getChatHistoryRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение истории сообщений в чате
[apiInstance getChatHistoryWith:businessId
    chatId:chatId
    getChatHistoryRequest:getChatHistoryRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatHistoryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var getChatHistoryRequest = ; // {GetChatHistoryRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatHistory(businessId, chatId, getChatHistoryRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatHistoryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение истории сообщений в чате
                GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getChatHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$getChatHistoryRequest = ; // GetChatHistoryRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChatHistory($businessId, $chatId, $getChatHistoryRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $getChatHistoryRequest = WWW::OPenAPIClient::Object::GetChatHistoryRequest->new(); # GetChatHistoryRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChatHistory(businessId => $businessId, chatId => $chatId, getChatHistoryRequest => $getChatHistoryRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getChatHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
getChatHistoryRequest =  # GetChatHistoryRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение истории сообщений в чате
    api_response = api_instance.get_chat_history(businessId, chatId, getChatHistoryRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getChatHistory: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let getChatHistoryRequest = ; // GetChatHistoryRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatHistoryRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getChats

Получение доступных чатов

Возвращает ваши чаты с покупателями. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "types" : [ "CHAT", "CHAT" ],
  "statuses" : [ "NEW", "NEW" ],
  "orderIds" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getChats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetChatsRequest getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChats(businessId, getChatsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChats: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getChats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetChatsRequest *getChatsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение доступных чатов
[apiInstance getChatsWith:businessId
    getChatsRequest:getChatsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getChatsRequest = ; // {GetChatsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChats(businessId, getChatsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение доступных чатов
                GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getChatsRequest = ; // GetChatsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChats($businessId, $getChatsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getChatsRequest = WWW::OPenAPIClient::Object::GetChatsRequest->new(); # GetChatsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChats(businessId => $businessId, getChatsRequest => $getChatsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getChatsRequest =  # GetChatsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение доступных чатов
    api_response = api_instance.get_chats(businessId, getChatsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getChats: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getChatsRequest = ; // GetChatsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getChats(businessId, getChatsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatsRequest *

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getDeliveryServices

Справочник служб доставки

Возвращает справочник служб доставки: идентификаторы и наименования. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/delivery/services

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/delivery/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDeliveryServices();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDeliveryServices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();

        try {
            GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getDeliveryServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];

// Справочник служб доставки
[apiInstance getDeliveryServicesWithCompletionHandler: 
              ^(GetDeliveryServicesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryServices(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getDeliveryServicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();

            try {
                // Справочник служб доставки
                GetDeliveryServicesResponse result = apiInstance.getDeliveryServices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getDeliveryServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();

try {
    $result = $api_instance->getDeliveryServices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getDeliveryServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();

eval {
    my $result = $api_instance->getDeliveryServices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getDeliveryServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()

try:
    # Справочник служб доставки
    api_response = api_instance.get_delivery_services()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getDeliveryServices: %s\n" % e)
extern crate FbsApi;

pub fn main() {

    let mut context = FbsApi::Context::default();
    let result = client.getDeliveryServices(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


getFeed

Информация о прайс-листе

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.getFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeed: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Информация о прайс-листе
[apiInstance getFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(GetFeedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Информация о прайс-листе
                GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->getFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->getFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Информация о прайс-листе
    api_response = api_instance.get_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getFeed: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


getFeedIndexLogs

Отчет по индексации прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра `generationId`. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}/index-logs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs?limit=20&published_time_from=2013-10-20T19:20:30+01:00&published_time_to=2013-10-20T19:20:30+01:00&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Date publishedTimeFrom = new Date(); // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

final Date publishedTimeTo = new Date(); // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

final FeedIndexLogsStatusType status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    final result = await api_instance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedIndexLogs: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Date *publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
Date *publishedTimeTo = 2013-10-20T19:20:30+01:00; // Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
FeedIndexLogsStatusType *status = ; // Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

// Отчет по индексации прайс-листа
[apiInstance getFeedIndexLogsWith:campaignId
    feedId:feedId
    limit:limit
    publishedTimeFrom:publishedTimeFrom
    publishedTimeTo:publishedTimeTo
    status:status
              completionHandler: ^(GetFeedIndexLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var opts = {
  'limit': 20, // {Integer} Количество значений на одной странице.

  'publishedTimeFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

  'publishedTimeTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

  'status':  // {FeedIndexLogsStatusType} Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedIndexLogs(campaignId, feedId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedIndexLogsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var publishedTimeFrom = 2013-10-20T19:20:30+01:00;  // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional)  (default to null)
            var publishedTimeTo = 2013-10-20T19:20:30+01:00;  // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional)  (default to null)
            var status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional)  (default to null)

            try {
                // Отчет по индексации прайс-листа
                GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getFeedIndexLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$limit = 20; // Integer | Количество значений на одной странице.

$publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

$publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

$status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    $result = $api_instance->getFeedIndexLogs($campaignId, $feedId, $limit, $publishedTimeFrom, $publishedTimeTo, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $limit = 20; # Integer | Количество значений на одной странице.

my $publishedTimeFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

my $publishedTimeTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

my $status = ; # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


eval {
    my $result = $api_instance->getFeedIndexLogs(campaignId => $campaignId, feedId => $feedId, limit => $limit, publishedTimeFrom => $publishedTimeFrom, publishedTimeTo => $publishedTimeTo, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getFeedIndexLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
publishedTimeFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
publishedTimeTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
status =  # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

try:
    # Отчет по индексации прайс-листа
    api_response = api_instance.get_feed_index_logs(campaignId, feedId, limit=limit, publishedTimeFrom=publishedTimeFrom, publishedTimeTo=publishedTimeTo, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getFeedIndexLogs: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let limit = 20; // Integer
    let publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date
    let publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date
    let status = ; // FeedIndexLogsStatusType

    let mut context = FbsApi::Context::default();
    let result = client.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Query parameters
Name Description
limit
Integer (int32)
Количество значений на одной странице.
published_time_from
Date (date-time)
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.
published_time_to
Date (date-time)
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}
status
FeedIndexLogsStatusType
Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

Responses


getFeedbackAndCommentUpdates

Новые и обновленные отзывы о магазине

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает новые и обновленные отзывы о магазине на Маркете. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/feedback/updates

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feedback/updates?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&from_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final date fromDate = new date(); // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    final result = await api_instance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedbackAndCommentUpdates: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
date *fromDate = 2013-10-20; // Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

// Новые и обновленные отзывы о магазине
[apiInstance getFeedbackAndCommentUpdatesWith:campaignId
    pageToken:pageToken
    limit:limit
    fromDate:fromDate
              completionHandler: ^(GetFeedbackListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'fromDate': 2013-10-20 // {date} Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedbackAndCommentUpdates(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedbackAndCommentUpdatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var fromDate = 2013-10-20;  // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)

            try {
                // Новые и обновленные отзывы о магазине
                GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getFeedbackAndCommentUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    $result = $api_instance->getFeedbackAndCommentUpdates($campaignId, $pageToken, $limit, $fromDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getFeedbackAndCommentUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $fromDate = 2013-10-20; # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


eval {
    my $result = $api_instance->getFeedbackAndCommentUpdates(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, fromDate => $fromDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getFeedbackAndCommentUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
fromDate = 2013-10-20 # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

try:
    # Новые и обновленные отзывы о магазине
    api_response = api_instance.get_feedback_and_comment_updates(campaignId, pageToken=pageToken, limit=limit, fromDate=fromDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getFeedbackAndCommentUpdates: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let fromDate = 2013-10-20; // date

    let mut context = FbsApi::Context::default();
    let result = client.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
from_date
date (date)
Начальная дата обновления отзывов. Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты. Формат даты: `ГГГГ-ММ-ДД`.

Responses


getFeeds

Список прайс-листов магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getFeeds(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeeds: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список прайс-листов магазина
[apiInstance getFeedsWith:campaignId
              completionHandler: ^(GetFeedsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список прайс-листов магазина
                GetFeedsResponse result = apiInstance.getFeeds(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getFeeds($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getFeeds(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getFeeds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список прайс-листов магазина
    api_response = api_instance.get_feeds(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getFeeds: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getFeeds(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getGoodsFeedbackComments

Получение комментариев к отзыву

Возвращает комментарии к отзыву. Результаты возвращаются постранично, одна страница содержит не более 20 комментариев. Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "feedbackId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbackComments: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsFeedbackCommentsRequest *getGoodsFeedbackCommentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение комментариев к отзыву
[apiInstance getGoodsFeedbackCommentsWith:businessId
    getGoodsFeedbackCommentsRequest:getGoodsFeedbackCommentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetGoodsFeedbackCommentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsFeedbackCommentsRequest = ; // {GetGoodsFeedbackCommentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbackCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение комментариев к отзыву
                GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getGoodsFeedbackComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getGoodsFeedbackComments($businessId, $getGoodsFeedbackCommentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getGoodsFeedbackComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsFeedbackCommentsRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackCommentsRequest->new(); # GetGoodsFeedbackCommentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getGoodsFeedbackComments(businessId => $businessId, getGoodsFeedbackCommentsRequest => $getGoodsFeedbackCommentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getGoodsFeedbackComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsFeedbackCommentsRequest =  # GetGoodsFeedbackCommentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение комментариев к отзыву
    api_response = api_instance.get_goods_feedback_comments(businessId, getGoodsFeedbackCommentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getGoodsFeedbackComments: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackCommentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsFeedbacks

Получение отзывов о товарах продавца

Возвращает все отзывы о товарах продавца по указанным фильтрам. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "ratingValues" : [ 0, 0, 0, 0, 0 ],
  "modelIds" : [ 6, 6, 6, 6, 6 ],
  "paid" : true,
  "reactionStatus" : "ALL",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetGoodsFeedbackRequest getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest | 

try {
    final result = await api_instance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbacks: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetGoodsFeedbackRequest *getGoodsFeedbackRequest = ; //  (optional)

// Получение отзывов о товарах продавца
[apiInstance getGoodsFeedbacksWith:businessId
    pageToken:pageToken
    limit:limit
    getGoodsFeedbackRequest:getGoodsFeedbackRequest
              completionHandler: ^(GetGoodsFeedbackResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getGoodsFeedbackRequest':  // {GetGoodsFeedbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbacks(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest |  (optional) 

            try {
                // Получение отзывов о товарах продавца
                GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getGoodsFeedbacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

try {
    $result = $api_instance->getGoodsFeedbacks($businessId, $pageToken, $limit, $getGoodsFeedbackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getGoodsFeedbacks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackRequest->new(); # GetGoodsFeedbackRequest | 

eval {
    my $result = $api_instance->getGoodsFeedbacks(businessId => $businessId, pageToken => $pageToken, limit => $limit, getGoodsFeedbackRequest => $getGoodsFeedbackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getGoodsFeedbacks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getGoodsFeedbackRequest =  # GetGoodsFeedbackRequest |  (optional)

try:
    # Получение отзывов о товарах продавца
    api_response = api_instance.get_goods_feedbacks(businessId, pageToken=pageToken, limit=limit, getGoodsFeedbackRequest=getGoodsFeedbackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getGoodsFeedbacks: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest

    let mut context = FbsApi::Context::default();
    let result = client.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsStats

Отчет по товарам

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/stats/skus

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/skus" \
 -d '{
  "shopSkus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsStatsRequest getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

try {
    final result = await api_instance.getGoodsStats(campaignId, getGoodsStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsStats: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsStatsRequest *getGoodsStatsRequest = ; // 

// Отчет по товарам
[apiInstance getGoodsStatsWith:campaignId
    getGoodsStatsRequest:getGoodsStatsRequest
              completionHandler: ^(GetGoodsStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsStatsRequest = ; // {GetGoodsStatsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsStats(campaignId, getGoodsStatsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

            try {
                // Отчет по товарам
                GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getGoodsStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

try {
    $result = $api_instance->getGoodsStats($campaignId, $getGoodsStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getGoodsStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsStatsRequest = WWW::OPenAPIClient::Object::GetGoodsStatsRequest->new(); # GetGoodsStatsRequest | 

eval {
    my $result = $api_instance->getGoodsStats(campaignId => $campaignId, getGoodsStatsRequest => $getGoodsStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getGoodsStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsStatsRequest =  # GetGoodsStatsRequest | 

try:
    # Отчет по товарам
    api_response = api_instance.get_goods_stats(campaignId, getGoodsStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getGoodsStats: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getGoodsStatsRequest = ; // GetGoodsStatsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getGoodsStats(campaignId, getGoodsStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsStatsRequest *

Responses


getHiddenOffers

Информация о скрытых вами товарах

Возвращает список скрытых вами товаров для заданного магазина. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers?offer_id=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&offset=56&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Integer offset = new Integer(); // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор скрытого предложения.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Integer *offset = 56; // Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о скрытых вами товарах
[apiInstance getHiddenOffersWith:campaignId
    offerId:offerId
    pageToken:pageToken
    limit:limit
    offset:offset
    page:page
    pageSize:pageSize
              completionHandler: ^(GetHiddenOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор скрытого предложения.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'offset': 56, // {Integer} Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHiddenOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var offset = 56;  // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о скрытых вами товарах
                GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор скрытого предложения.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getHiddenOffers($campaignId, $offerId, $pageToken, $limit, $offset, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор скрытого предложения.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $offset = 56; # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getHiddenOffers(campaignId => $campaignId, offerId => $offerId, pageToken => $pageToken, limit => $limit, offset => $offset, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор скрытого предложения.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
offset = 56 # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о скрытых вами товарах
    api_response = api_instance.get_hidden_offers(campaignId, offerId=offerId, pageToken=pageToken, limit=limit, offset=offset, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getHiddenOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let offset = 56; // Integer
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор скрытого предложения.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
offset
Integer (int32)
Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOfferCardsContentStatus

Получение информации о заполненности карточек магазина

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * переданные характеристики товаров; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |**⚙️ Лимит:** 600 запросов в минуту| |-|


/businesses/{businessId}/offer-cards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ null, null, null, null, null ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest | 

try {
    final result = await api_instance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferCardsContentStatus: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferCardsContentStatusRequest *getOfferCardsContentStatusRequest = ; //  (optional)

// Получение информации о заполненности карточек магазина
[apiInstance getOfferCardsContentStatusWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferCardsContentStatusRequest:getOfferCardsContentStatusRequest
              completionHandler: ^(GetOfferCardsContentStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferCardsContentStatusRequest':  // {GetOfferCardsContentStatusRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferCardsContentStatus(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferCardsContentStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest |  (optional) 

            try {
                // Получение информации о заполненности карточек магазина
                GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOfferCardsContentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

try {
    $result = $api_instance->getOfferCardsContentStatus($businessId, $pageToken, $limit, $getOfferCardsContentStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOfferCardsContentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferCardsContentStatusRequest = WWW::OPenAPIClient::Object::GetOfferCardsContentStatusRequest->new(); # GetOfferCardsContentStatusRequest | 

eval {
    my $result = $api_instance->getOfferCardsContentStatus(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferCardsContentStatusRequest => $getOfferCardsContentStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOfferCardsContentStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferCardsContentStatusRequest =  # GetOfferCardsContentStatusRequest |  (optional)

try:
    # Получение информации о заполненности карточек магазина
    api_response = api_instance.get_offer_cards_content_status(businessId, pageToken=pageToken, limit=limit, getOfferCardsContentStatusRequest=getOfferCardsContentStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOfferCardsContentStatus: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest

    let mut context = FbsApi::Context::default();
    let result = client.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferCardsContentStatusRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappingEntries

Список товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров в каталоге магазина * 25)


/campaigns/{campaignId}/offer-mapping-entries

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries?offer_id=&shop_sku=&mapping_kind=&status=&availability=&category_id=&vendor=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор товара в каталоге.
final array[String] shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final OfferMappingKindType mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
final array[OfferProcessingStatusType] status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final array[OfferAvailabilityStatusType] availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[Integer] categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[String] vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор товара в каталоге. (optional) (default to null)
array[String] *shopSku = ; // Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
OfferMappingKindType *mappingKind = ; // Тип маппинга. (optional) (default to null)
array[OfferProcessingStatusType] *status = ; // Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[OfferAvailabilityStatusType] *availability = ; // Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[Integer] *categoryId = ; // Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[String] *vendor = ; // Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров в каталоге
[apiInstance getOfferMappingEntriesWith:campaignId
    offerId:offerId
    shopSku:shopSku
    mappingKind:mappingKind
    status:status
    availability:availability
    categoryId:categoryId
    vendor:vendor
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор товара в каталоге.
  'shopSku': , // {array[String]} Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'mappingKind': , // {OfferMappingKindType} Тип маппинга.
  'status': , // {array[OfferProcessingStatusType]} Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'availability': , // {array[OfferAvailabilityStatusType]} Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'categoryId': , // {array[Integer]} Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'vendor': , // {array[String]} Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappingEntries(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор товара в каталоге. (optional)  (default to null)
            var shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга. (optional)  (default to null)
            var status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров в каталоге
                GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор товара в каталоге.
$shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$mappingKind = ; // OfferMappingKindType | Тип маппинга.
$status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferMappingEntries($campaignId, $offerId, $shopSku, $mappingKind, $status, $availability, $categoryId, $vendor, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор товара в каталоге.
my $shopSku = []; # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $mappingKind = ; # OfferMappingKindType | Тип маппинга.
my $status = []; # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $availability = []; # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $categoryId = []; # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $vendor = []; # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferMappingEntries(campaignId => $campaignId, offerId => $offerId, shopSku => $shopSku, mappingKind => $mappingKind, status => $status, availability => $availability, categoryId => $categoryId, vendor => $vendor, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор товара в каталоге. (optional) (default to null)
shopSku =  # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
mappingKind =  # OfferMappingKindType | Тип маппинга. (optional) (default to null)
status =  # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
availability =  # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
categoryId =  # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
vendor =  # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров в каталоге
    api_response = api_instance.get_offer_mapping_entries(campaignId, offerId=offerId, shopSku=shopSku, mappingKind=mappingKind, status=status, availability=availability, categoryId=categoryId, vendor=vendor, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOfferMappingEntries: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let shopSku = ; // array[String]
    let mappingKind = ; // OfferMappingKindType
    let status = ; // array[OfferProcessingStatusType]
    let availability = ; // array[OfferAvailabilityStatusType]
    let categoryId = ; // array[Integer]
    let vendor = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор товара в каталоге.
shop_sku
array[String]
Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
mapping_kind
OfferMappingKindType
Тип маппинга.
status
array[OfferProcessingStatusType]
Фильтрация по статусу публикации товара: * `READY` — товар прошел модерацию. * `IN_WORK` — товар проходит модерацию. * `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * `OTHER` — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
availability
array[OfferAvailabilityStatusType]
Фильтрация по планам поставок товара: * `ACTIVE` — поставки будут. * `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
category_id
array[Integer]
Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md). Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
vendor
array[String]
Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL). В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappings

Информация о товарах в каталоге

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара. Можно использовать тремя способами: * задать список интересующих SKU; * задать фильтр — в этом случае результаты возвращаются постранично; * не передавать тело запроса, чтобы получить список всех товаров в каталоге. |**⚙️ Лимит:** 600 запросов в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferMappingsRequest getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest | 

try {
    final result = await api_instance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferMappingsRequest *getOfferMappingsRequest = ; //  (optional)

// Информация о товарах в каталоге
[apiInstance getOfferMappingsWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferMappingsRequest:getOfferMappingsRequest
              completionHandler: ^(GetOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferMappingsRequest':  // {GetOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest |  (optional) 

            try {
                // Информация о товарах в каталоге
                GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

try {
    $result = $api_instance->getOfferMappings($businessId, $pageToken, $limit, $getOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferMappingsRequest = WWW::OPenAPIClient::Object::GetOfferMappingsRequest->new(); # GetOfferMappingsRequest | 

eval {
    my $result = $api_instance->getOfferMappings(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferMappingsRequest => $getOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferMappingsRequest =  # GetOfferMappingsRequest |  (optional)

try:
    # Информация о товарах в каталоге
    api_response = api_instance.get_offer_mappings(businessId, pageToken=pageToken, limit=limit, getOfferMappingsRequest=getOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOfferMappings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferMappingsRequest = ; // GetOfferMappingsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferMappingsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferRecommendations

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. **1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.** Показывает, какие **цены для участия** нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#sponsored-discounts) **2. Оценка привлекательности цен на витрине.** Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#validation) В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/offers/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cofinancePriceFilter" : "SPECIFIED",
  "competitivenessFilter" : "OPTIMAL",
  "offerIds" : [ null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetOfferRecommendationsRequest getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferRecommendations: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetOfferRecommendationsRequest *getOfferRecommendationsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Рекомендации Маркета, касающиеся цен
[apiInstance getOfferRecommendationsWith:businessId
    getOfferRecommendationsRequest:getOfferRecommendationsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getOfferRecommendationsRequest = ; // {GetOfferRecommendationsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferRecommendations(businessId, getOfferRecommendationsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Рекомендации Маркета, касающиеся цен
                GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOfferRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferRecommendations($businessId, $getOfferRecommendationsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getOfferRecommendationsRequest = WWW::OPenAPIClient::Object::GetOfferRecommendationsRequest->new(); # GetOfferRecommendationsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferRecommendations(businessId => $businessId, getOfferRecommendationsRequest => $getOfferRecommendationsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOfferRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getOfferRecommendationsRequest =  # GetOfferRecommendationsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Рекомендации Маркета, касающиеся цен
    api_response = api_instance.get_offer_recommendations(businessId, getOfferRecommendationsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOfferRecommendations: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferRecommendationsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOffers

Предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?query=query_example&feedId=789&shopCategoryId=shopCategoryId_example¤cy=&matched=true&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String query = new String(); // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final String shopCategoryId = new String(); // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

final Boolean matched = new Boolean(); // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *query = query_example; // Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
String *shopCategoryId = shopCategoryId_example; // Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
CurrencyType *currency = ; // Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
Boolean *matched = true; // Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Предложения магазина
[apiInstance getOffersWith:campaignId
    query:query
    feedId:feedId
    shopCategoryId:shopCategoryId
    currency:currency
    matched:matched
    page:page
    pageSize:pageSize
              completionHandler: ^(GetOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'query': query_example, // {String} Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'shopCategoryId': shopCategoryId_example, // {String} Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

  'currency': , // {CurrencyType} Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

  'matched': true, // {Boolean} Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var query = query_example;  // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional)  (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var shopCategoryId = shopCategoryId_example;  // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional)  (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional)  (default to null)
            var matched = true;  // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Предложения магазина
                GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

$feedId = 789; // Long | Идентификатор прайс-листа.
$shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

$currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

$matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getOffers($campaignId, $query, $feedId, $shopCategoryId, $currency, $matched, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $query = query_example; # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $shopCategoryId = shopCategoryId_example; # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

my $currency = ; # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

my $matched = true; # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getOffers(campaignId => $campaignId, query => $query, feedId => $feedId, shopCategoryId => $shopCategoryId, currency => $currency, matched => $matched, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
query = query_example # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
shopCategoryId = shopCategoryId_example # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
currency =  # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
matched = true # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Предложения магазина
    api_response = api_instance.get_offers(campaignId, query=query, feedId=feedId, shopCategoryId=shopCategoryId, currency=currency, matched=matched, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let query = query_example; // String
    let feedId = 789; // Long
    let shopCategoryId = shopCategoryId_example; // String
    let currency = ; // CurrencyType
    let matched = true; // Boolean
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
query
String
Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId
Long (int64)
Идентификатор прайс-листа.
shopCategoryId
String
Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency
CurrencyType
Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.
matched
Boolean
Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOrder

Информация об одном заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrder");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrder(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrder: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация об одном заказе
[apiInstance getOrderWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация об одном заказе
                GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrder($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrder(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация об одном заказе
    api_response = api_instance.get_order(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOrder: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getOrder(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessBuyerInfo

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY`, `PICKUP` или `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/business-buyer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/business-buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessBuyerInfo: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — юридическом лице
[apiInstance getOrderBusinessBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — юридическом лице
                GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOrderBusinessBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOrderBusinessBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — юридическом лице
    api_response = api_instance.get_order_business_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOrderBusinessBuyerInfo: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getOrderBusinessBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessDocumentsInfo

Информация о документах

Возвращает информацию о документах по идентификатору заказа. Получить данные можно после того, как заказ перейдет в статус `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/documents

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessDocumentsInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessDocumentsInfo: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о документах
[apiInstance getOrderBusinessDocumentsInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessDocumentsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessDocumentsInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessDocumentsInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о документах
                GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOrderBusinessDocumentsInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessDocumentsInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessDocumentsInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOrderBusinessDocumentsInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о документах
    api_response = api_instance.get_order_business_documents_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOrderBusinessDocumentsInfo: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getOrderBusinessDocumentsInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderLabelsData

Данные для самостоятельного изготовления ярлыков

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderLabelsData(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderLabelsData: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Данные для самостоятельного изготовления ярлыков
[apiInstance getOrderLabelsDataWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderLabelsDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderLabelsData(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderLabelsDataExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Данные для самостоятельного изготовления ярлыков
                GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOrderLabelsData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderLabelsData($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOrderLabelsData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderLabelsData(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOrderLabelsData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Данные для самостоятельного изготовления ярлыков
    api_response = api_instance.get_order_labels_data(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOrderLabelsData: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getOrderLabelsData(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrders

Информация о нескольких заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * идентификаторам заказов; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) (если у вас есть идентификатор заказа) или запроса отчета по заказам [POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md). Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Для навигации по страницам используйте параметры `page_token` и `limit`. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders?orderIds=&status=&substatus=&fromDate=2013-10-20&toDate=2013-10-20&supplierShipmentDateFrom=2013-10-20&supplierShipmentDateTo=2013-10-20&updatedAtFrom=2013-10-20T19:20:30+01:00&updatedAtTo=2013-10-20T19:20:30+01:00&dispatchType=&fake=true&hasCis=true&onlyWaitingForCancellationApprove=true&onlyEstimatedDelivery=true&buyerType=&page=56&pageSize=56&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FbsApi#getOrders"); e.printStackTrace(); } } }
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[Long] orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. final set[OrderStatusType] status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. final set[OrderSubstatusType] substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. final date fromDate = new date(); // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. final date toDate = new date(); // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. final date supplierShipmentDateFrom = new date(); // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final date supplierShipmentDateTo = new date(); // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final Date updatedAtFrom = new Date(); // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final Date updatedAtTo = new Date(); // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final OrderDeliveryDispatchType dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки final Boolean fake = new Boolean(); // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. final Boolean hasCis = new Boolean(); // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. final Boolean onlyWaitingForCancellationApprove = new Boolean(); // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). final Boolean onlyEstimatedDelivery = new Boolean(); // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. final OrderBuyerType buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. final Integer page = new Integer(); // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. final Integer pageSize = new Integer(); // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. final String pageToken = new String(); // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. final Integer limit = new Integer(); // Integer | Количество значений на одной странице. try { final result = await api_instance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); print(result); } catch (e) { print('Exception when calling DefaultApi->getOrders: $e\n'); }
import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FbsApi#getOrders"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[Long] *orderIds = ; // Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) set[OrderStatusType] *status = ; // Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) set[OrderSubstatusType] *substatus = ; // Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) date *fromDate = 2013-10-20; // Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) date *toDate = 2013-10-20; // Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) date *supplierShipmentDateFrom = 2013-10-20; // Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) date *supplierShipmentDateTo = 2013-10-20; // Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtFrom = 2013-10-20T19:20:30+01:00; // Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtTo = 2013-10-20T19:20:30+01:00; // Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) OrderDeliveryDispatchType *dispatchType = ; // Способ отгрузки (optional) (default to null) Boolean *fake = true; // Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) Boolean *hasCis = true; // Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) Boolean *onlyWaitingForCancellationApprove = true; // **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) Boolean *onlyEstimatedDelivery = true; // Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) OrderBuyerType *buyerType = ; // Фильтрация заказов по типу покупателя. (optional) (default to null) Integer *page = 56; // Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) Integer *pageSize = 56; // Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) Integer *limit = 20; // Количество значений на одной странице. (optional) (default to null) // Информация о нескольких заказах [apiInstance getOrdersWith:campaignId orderIds:orderIds status:status substatus:substatus fromDate:fromDate toDate:toDate supplierShipmentDateFrom:supplierShipmentDateFrom supplierShipmentDateTo:supplierShipmentDateTo updatedAtFrom:updatedAtFrom updatedAtTo:updatedAtTo dispatchType:dispatchType fake:fake hasCis:hasCis onlyWaitingForCancellationApprove:onlyWaitingForCancellationApprove onlyEstimatedDelivery:onlyEstimatedDelivery buyerType:buyerType page:page pageSize:pageSize pageToken:pageToken limit:limit completionHandler: ^(GetOrdersResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'orderIds': , // {array[Long]} Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. 'status': , // {set[OrderStatusType]} Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. 'substatus': , // {set[OrderSubstatusType]} Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. 'fromDate': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. 'toDate': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. 'supplierShipmentDateFrom': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'supplierShipmentDateTo': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'updatedAtFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'updatedAtTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'dispatchType': , // {OrderDeliveryDispatchType} Способ отгрузки 'fake': true, // {Boolean} Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. 'hasCis': true, // {Boolean} Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. 'onlyWaitingForCancellationApprove': true, // {Boolean} **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). 'onlyEstimatedDelivery': true, // {Boolean} Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. 'buyerType': , // {OrderBuyerType} Фильтрация заказов по типу покупателя. 'page': 56, // {Integer} Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageSize': 56, // {Integer} Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. 'limit': 20 // {Integer} Количество значений на одной странице. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getOrders(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) var status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) var toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) var supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) var fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) var hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) var onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) var onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) var buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) var page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) var pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) var limit = 20; // Integer | Количество значений на одной странице. (optional) (default to null) try { // Информация о нескольких заказах GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling FbsApi.getOrders: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. $status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. $substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. $fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. $toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. $supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки $fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. $hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. $onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). $onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. $buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. $page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. $pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. $limit = 20; // Integer | Количество значений на одной странице. try { $result = $api_instance->getOrders($campaignId, $orderIds, $status, $substatus, $fromDate, $toDate, $supplierShipmentDateFrom, $supplierShipmentDateTo, $updatedAtFrom, $updatedAtTo, $dispatchType, $fake, $hasCis, $onlyWaitingForCancellationApprove, $onlyEstimatedDelivery, $buyerType, $page, $pageSize, $pageToken, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling FbsApi->getOrders: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderIds = []; # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. my $status = []; # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. my $substatus = []; # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. my $fromDate = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. my $toDate = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. my $supplierShipmentDateFrom = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $supplierShipmentDateTo = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $updatedAtFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $updatedAtTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $dispatchType = ; # OrderDeliveryDispatchType | Способ отгрузки my $fake = true; # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. my $hasCis = true; # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. my $onlyWaitingForCancellationApprove = true; # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). my $onlyEstimatedDelivery = true; # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. my $buyerType = ; # OrderBuyerType | Фильтрация заказов по типу покупателя. my $page = 56; # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageSize = 56; # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. my $limit = 20; # Integer | Количество значений на одной странице. eval { my $result = $api_instance->getOrders(campaignId => $campaignId, orderIds => $orderIds, status => $status, substatus => $substatus, fromDate => $fromDate, toDate => $toDate, supplierShipmentDateFrom => $supplierShipmentDateFrom, supplierShipmentDateTo => $supplierShipmentDateTo, updatedAtFrom => $updatedAtFrom, updatedAtTo => $updatedAtTo, dispatchType => $dispatchType, fake => $fake, hasCis => $hasCis, onlyWaitingForCancellationApprove => $onlyWaitingForCancellationApprove, onlyEstimatedDelivery => $onlyEstimatedDelivery, buyerType => $buyerType, page => $page, pageSize => $pageSize, pageToken => $pageToken, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling FbsApi->getOrders: $@\n"; }
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderIds =  # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) status = # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) substatus = # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) fromDate = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) toDate = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) supplierShipmentDateFrom = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) supplierShipmentDateTo = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) updatedAtFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) updatedAtTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) dispatchType = # OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) fake = true # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) hasCis = true # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) onlyWaitingForCancellationApprove = true # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) onlyEstimatedDelivery = true # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) buyerType = # OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) page = 56 # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) pageSize = 56 # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) limit = 20 # Integer | Количество значений на одной странице. (optional) (default to null) try: # Информация о нескольких заказах api_response = api_instance.get_orders(campaignId, orderIds=orderIds, status=status, substatus=substatus, fromDate=fromDate, toDate=toDate, supplierShipmentDateFrom=supplierShipmentDateFrom, supplierShipmentDateTo=supplierShipmentDateTo, updatedAtFrom=updatedAtFrom, updatedAtTo=updatedAtTo, dispatchType=dispatchType, fake=fake, hasCis=hasCis, onlyWaitingForCancellationApprove=onlyWaitingForCancellationApprove, onlyEstimatedDelivery=onlyEstimatedDelivery, buyerType=buyerType, page=page, pageSize=pageSize, pageToken=pageToken, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling FbsApi->getOrders: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderIds = ; // array[Long]
    let status = ; // set[OrderStatusType]
    let substatus = ; // set[OrderSubstatusType]
    let fromDate = 2013-10-20; // date
    let toDate = 2013-10-20; // date
    let supplierShipmentDateFrom = 2013-10-20; // date
    let supplierShipmentDateTo = 2013-10-20; // date
    let updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date
    let updatedAtTo = 2013-10-20T19:20:30+01:00; // Date
    let dispatchType = ; // OrderDeliveryDispatchType
    let fake = true; // Boolean
    let hasCis = true; // Boolean
    let onlyWaitingForCancellationApprove = true; // Boolean
    let onlyEstimatedDelivery = true; // Boolean
    let buyerType = ; // OrderBuyerType
    let page = 56; // Integer
    let pageSize = 56; // Integer
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
orderIds
array[Long] (int64)
Фильтрация заказов по идентификаторам. <br><br> ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
status
set[OrderStatusType]
Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus
set[OrderSubstatusType]
Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.
fromDate
date (date)
Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
toDate
date (date)
Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.
supplierShipmentDateFrom
date (date)
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo
date (date)
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
updatedAtFrom
Date (date-time)
Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo
Date (date-time)
Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
dispatchType
OrderDeliveryDispatchType
Способ отгрузки
fake
Boolean
Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
hasCis
Boolean
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
onlyWaitingForCancellationApprove
Boolean
**Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
onlyEstimatedDelivery
Boolean
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
buyerType
OrderBuyerType
Фильтрация заказов по типу покупателя.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOrdersStats

Детальная информация по заказам

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п. {% note info "" %} Раньше генерация детальной информации по заказам называлась **Отчет по заказам**. Сейчас это новый отчет. [Подробнее об отчете](../../reference/reports/generateUnitedOrdersReport.md) {% endnote %} В одном запросе можно получить информацию не более чем по 200 заказам. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/stats/orders

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "updateTo" : "2000-01-23",
  "updateFrom" : "2000-01-23",
  "hasCis" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "CANCELLED_BEFORE_PROCESSING", "CANCELLED_BEFORE_PROCESSING" ],
  "orders" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOrdersStatsRequest getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest | 

try {
    final result = await api_instance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrdersStats: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOrdersStatsRequest *getOrdersStatsRequest = ; //  (optional)

// Детальная информация по заказам
[apiInstance getOrdersStatsWith:campaignId
    pageToken:pageToken
    limit:limit
    getOrdersStatsRequest:getOrdersStatsRequest
              completionHandler: ^(GetOrdersStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOrdersStatsRequest':  // {GetOrdersStatsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrdersStats(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest |  (optional) 

            try {
                // Детальная информация по заказам
                GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getOrdersStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

try {
    $result = $api_instance->getOrdersStats($campaignId, $pageToken, $limit, $getOrdersStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getOrdersStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOrdersStatsRequest = WWW::OPenAPIClient::Object::GetOrdersStatsRequest->new(); # GetOrdersStatsRequest | 

eval {
    my $result = $api_instance->getOrdersStats(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getOrdersStatsRequest => $getOrdersStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getOrdersStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOrdersStatsRequest =  # GetOrdersStatsRequest |  (optional)

try:
    # Детальная информация по заказам
    api_response = api_instance.get_orders_stats(campaignId, pageToken=pageToken, limit=limit, getOrdersStatsRequest=getOrdersStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getOrdersStats: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOrdersStatsRequest = ; // GetOrdersStatsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOrdersStatsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPrices

Список цен

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST campaigns/{campaignId}/offer-prices](../../reference/assortment/getPricesByOfferIds.md). {% endnote %} Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом. {% note info %} Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов. {% endnote %} Способы установки цен описаны [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/assortment/operations/prices.html). |**⚙️ Лимит:** ```(количество товаров партнера на витрине) * 25``` товаров в сутки| |-|


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&archived=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Boolean archived = new Boolean(); // Boolean | Фильтр по нахождению в архиве.

try {
    final result = await api_instance.getPrices(campaignId, pageToken, limit, archived);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Boolean *archived = true; // Фильтр по нахождению в архиве. (optional) (default to false)

// Список цен
[apiInstance getPricesWith:campaignId
    pageToken:pageToken
    limit:limit
    archived:archived
              completionHandler: ^(GetPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'archived': true // {Boolean} Фильтр по нахождению в архиве.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrices(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var archived = true;  // Boolean | Фильтр по нахождению в архиве. (optional)  (default to false)

            try {
                // Список цен
                GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$archived = true; // Boolean | Фильтр по нахождению в архиве.

try {
    $result = $api_instance->getPrices($campaignId, $pageToken, $limit, $archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $archived = true; # Boolean | Фильтр по нахождению в архиве.

eval {
    my $result = $api_instance->getPrices(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, archived => $archived);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
archived = true # Boolean | Фильтр по нахождению в архиве. (optional) (default to false)

try:
    # Список цен
    api_response = api_instance.get_prices(campaignId, pageToken=pageToken, limit=limit, archived=archived)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getPrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let archived = true; // Boolean

    let mut context = FbsApi::Context::default();
    let result = client.getPrices(campaignId, pageToken, limit, archived, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
archived
Boolean
Фильтр по нахождению в архиве.

Responses


getPricesByOfferIds

Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине. {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для просмотра базовых цен используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров на витрине * 25)


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest | 

try {
    final result = await api_instance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPricesByOfferIds: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetPricesByOfferIdsRequest *getPricesByOfferIdsRequest = ; //  (optional)

// Просмотр цен на указанные товары в магазине
[apiInstance getPricesByOfferIdsWith:campaignId
    pageToken:pageToken
    limit:limit
    getPricesByOfferIdsRequest:getPricesByOfferIdsRequest
              completionHandler: ^(GetPricesByOfferIdsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getPricesByOfferIdsRequest':  // {GetPricesByOfferIdsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPricesByOfferIds(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesByOfferIdsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest |  (optional) 

            try {
                // Просмотр цен на указанные товары в магазине
                GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getPricesByOfferIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

try {
    $result = $api_instance->getPricesByOfferIds($campaignId, $pageToken, $limit, $getPricesByOfferIdsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getPricesByOfferIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getPricesByOfferIdsRequest = WWW::OPenAPIClient::Object::GetPricesByOfferIdsRequest->new(); # GetPricesByOfferIdsRequest | 

eval {
    my $result = $api_instance->getPricesByOfferIds(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getPricesByOfferIdsRequest => $getPricesByOfferIdsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getPricesByOfferIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getPricesByOfferIdsRequest =  # GetPricesByOfferIdsRequest |  (optional)

try:
    # Просмотр цен на указанные товары в магазине
    api_response = api_instance.get_prices_by_offer_ids(campaignId, pageToken=pageToken, limit=limit, getPricesByOfferIdsRequest=getPricesByOfferIdsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getPricesByOfferIds: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPricesByOfferIdsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromoOffers

Получение списка товаров, которые участвуют или могут участвовать в акции

Возвращает список товаров, которые участвуют или могут участвовать в акции. {% note warning %} В параметре `limit` не передавайте значение больше 500. {% endnote %} |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "statusType" : "MANUALLY_ADDED",
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromoOffersRequest getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromoOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromoOffersRequest *getPromoOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение списка товаров, которые участвуют или могут участвовать в акции
[apiInstance getPromoOffersWith:businessId
    getPromoOffersRequest:getPromoOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetPromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getPromoOffersRequest = ; // {GetPromoOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromoOffers(businessId, getPromoOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение списка товаров, которые участвуют или могут участвовать в акции
                GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getPromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromoOffersRequest = ; // GetPromoOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getPromoOffers($businessId, $getPromoOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getPromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromoOffersRequest = WWW::OPenAPIClient::Object::GetPromoOffersRequest->new(); # GetPromoOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getPromoOffers(businessId => $businessId, getPromoOffersRequest => $getPromoOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getPromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromoOffersRequest =  # GetPromoOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение списка товаров, которые участвуют или могут участвовать в акции
    api_response = api_instance.get_promo_offers(businessId, getPromoOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getPromoOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromoOffersRequest = ; // GetPromoOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromoOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromos

Получение списка акций

Возвращает информацию об акциях Маркета. По умолчанию возвращаются акции, в которых продавец участвует или может принять участие. Чтобы получить текущие или завершенные акции, передайте параметр `participation`. Типы акций, которые возвращаются в ответе: * прямая скидка; * флеш-акция; * скидка по промокоду. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/promos

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos" \
 -d '{
  "participation" : "PARTICIPATING_NOW",
  "mechanics" : "DIRECT_DISCOUNT"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPromos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromosRequest getPromosRequest = new GetPromosRequest(); // GetPromosRequest | 

try {
    final result = await api_instance.getPromos(businessId, getPromosRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromos: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getPromos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromosRequest *getPromosRequest = ; //  (optional)

// Получение списка акций
[apiInstance getPromosWith:businessId
    getPromosRequest:getPromosRequest
              completionHandler: ^(GetPromosResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getPromosRequest':  // {GetPromosRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromos(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromosExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromosRequest = new GetPromosRequest(); // GetPromosRequest |  (optional) 

            try {
                // Получение списка акций
                GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getPromos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromosRequest = ; // GetPromosRequest | 

try {
    $result = $api_instance->getPromos($businessId, $getPromosRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getPromos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromosRequest = WWW::OPenAPIClient::Object::GetPromosRequest->new(); # GetPromosRequest | 

eval {
    my $result = $api_instance->getPromos(businessId => $businessId, getPromosRequest => $getPromosRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getPromos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromosRequest =  # GetPromosRequest |  (optional)

try:
    # Получение списка акций
    api_response = api_instance.get_promos(businessId, getPromosRequest=getPromosRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getPromos: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromosRequest = ; // GetPromosRequest

    let mut context = FbsApi::Context::default();
    let result = client.getPromos(businessId, getPromosRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromosRequest

Responses


getQualityRatingDetails

Заказы, которые повлияли на индекс качества

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос [POST businesses/{businessId}/ratings/quality](../../reference/ratings/getQualityRatings.md). |**⚙️ Лимит:** 100000 запросов в час| |-|


/campaigns/{campaignId}/ratings/quality/details

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/ratings/quality/details"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getQualityRatingDetails(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatingDetails: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Заказы, которые повлияли на индекс качества
[apiInstance getQualityRatingDetailsWith:campaignId
              completionHandler: ^(GetQualityRatingDetailsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatingDetails(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Заказы, которые повлияли на индекс качества
                GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getQualityRatingDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getQualityRatingDetails($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getQualityRatingDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getQualityRatingDetails(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getQualityRatingDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Заказы, которые повлияли на индекс качества
    api_response = api_instance.get_quality_rating_details(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getQualityRatingDetails: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getQualityRatingDetails(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getQualityRatings

Индекс качества магазинов

Возвращает значение индекса качества магазинов и его составляющие. Подробнее об индексе качества читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/quality/score/). |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/ratings/quality

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality" \
 -d '{
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 0, 0, 0, 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQualityRatingRequest getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

try {
    final result = await api_instance.getQualityRatings(businessId, getQualityRatingRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQualityRatingRequest *getQualityRatingRequest = ; // 

// Индекс качества магазинов
[apiInstance getQualityRatingsWith:businessId
    getQualityRatingRequest:getQualityRatingRequest
              completionHandler: ^(GetQualityRatingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQualityRatingRequest = ; // {GetQualityRatingRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatings(businessId, getQualityRatingRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

            try {
                // Индекс качества магазинов
                GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getQualityRatings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQualityRatingRequest = ; // GetQualityRatingRequest | 

try {
    $result = $api_instance->getQualityRatings($businessId, $getQualityRatingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getQualityRatings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQualityRatingRequest = WWW::OPenAPIClient::Object::GetQualityRatingRequest->new(); # GetQualityRatingRequest | 

eval {
    my $result = $api_instance->getQualityRatings(businessId => $businessId, getQualityRatingRequest => $getQualityRatingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getQualityRatings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQualityRatingRequest =  # GetQualityRatingRequest | 

try:
    # Индекс качества магазинов
    api_response = api_instance.get_quality_ratings(businessId, getQualityRatingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getQualityRatings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getQualityRatingRequest = ; // GetQualityRatingRequest

    let mut context = FbsApi::Context::default();
    let result = client.getQualityRatings(businessId, getQualityRatingRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQualityRatingRequest *

Responses


getReportInfo

Получение заданного отчета

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. [Инструкция](../../step-by-step/reports.md) |**⚙️ Лимит:** 100 запросов в минуту| |-|


/reports/info/{reportId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/reports/info/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportId = new String(); // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    final result = await api_instance.getReportInfo(reportId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReportInfo: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
String *reportId = reportId_example; // Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

// Получение заданного отчета
[apiInstance getReportInfoWith:reportId
              completionHandler: ^(GetReportInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var reportId = reportId_example; // {String} Идентификатор отчета, который вы получили после запуска генерации.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportInfo(reportId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReportInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var reportId = reportId_example;  // String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

            try {
                // Получение заданного отчета
                GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getReportInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    $result = $api_instance->getReportInfo($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getReportInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $reportId = reportId_example; # String | Идентификатор отчета, который вы получили после запуска генерации.


eval {
    my $result = $api_instance->getReportInfo(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getReportInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
reportId = reportId_example # String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

try:
    # Получение заданного отчета
    api_response = api_instance.get_report_info(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getReportInfo: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let reportId = reportId_example; // String

    let mut context = FbsApi::Context::default();
    let result = client.getReportInfo(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
reportId*
String
Идентификатор отчета, который вы получили после запуска генерации.
Required

Responses


getReturn

Информация о невыкупе или возврате

Получает информацию по одному невыкупу или возврату. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturn");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturn(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturn: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Информация о невыкупе или возврате
[apiInstance getReturnWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(GetReturnResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturn(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Информация о невыкупе или возврате
                GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getReturn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturn($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturn(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Информация о невыкупе или возврате
    api_response = api_instance.get_return(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getReturn: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getReturn(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnApplication

Получение заявления на возврат

Загружает заявление покупателя на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturnApplication(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnApplication: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Получение заявления на возврат
[apiInstance getReturnApplicationWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnApplication(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnApplicationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Получение заявления на возврат
                File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getReturnApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturnApplication($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getReturnApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturnApplication(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getReturnApplication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Получение заявления на возврат
    api_response = api_instance.get_return_application(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getReturnApplication: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getReturnApplication(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnPhoto

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final Long itemId = new Long(); // Long | Идентификатор товара в возврате.
final String imageHash = new String(); // String | Хеш ссылки изображения для загрузки.

try {
    final result = await api_instance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnPhoto: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
Long *itemId = 789; // Идентификатор товара в возврате. (default to null)
String *imageHash = imageHash_example; // Хеш ссылки изображения для загрузки. (default to null)

// Получение фотографии возврата
[apiInstance getReturnPhotoWith:campaignId
    orderId:orderId
    returnId:returnId
    itemId:itemId
    imageHash:imageHash
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var itemId = 789; // {Long} Идентификатор товара в возврате.
var imageHash = imageHash_example; // {String} Хеш ссылки изображения для загрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnPhotoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var itemId = 789;  // Long | Идентификатор товара в возврате. (default to null)
            var imageHash = imageHash_example;  // String | Хеш ссылки изображения для загрузки. (default to null)

            try {
                // Получение фотографии возврата
                File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getReturnPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$itemId = 789; // Long | Идентификатор товара в возврате.
$imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

try {
    $result = $api_instance->getReturnPhoto($campaignId, $orderId, $returnId, $itemId, $imageHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $itemId = 789; # Long | Идентификатор товара в возврате.
my $imageHash = imageHash_example; # String | Хеш ссылки изображения для загрузки.

eval {
    my $result = $api_instance->getReturnPhoto(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, itemId => $itemId, imageHash => $imageHash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getReturnPhoto: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
itemId = 789 # Long | Идентификатор товара в возврате. (default to null)
imageHash = imageHash_example # String | Хеш ссылки изображения для загрузки. (default to null)

try:
    # Получение фотографии возврата
    api_response = api_instance.get_return_photo(campaignId, orderId, returnId, itemId, imageHash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getReturnPhoto: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let itemId = 789; // Long
    let imageHash = imageHash_example; // String

    let mut context = FbsApi::Context::default();
    let result = client.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
itemId*
Long (int64)
Идентификатор товара в возврате.
Required
imageHash*
String
Хеш ссылки изображения для загрузки.
Required

Responses


getReturns

Список невыкупов и возвратов

Получает список невыкупов и возвратов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос [GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}](../../reference/orders/getReturn.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/returns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&orderIds=&statuses=STARTED_BY_USER,WAITING_FOR_DECISION&type=&fromDate=2022-10-31&toDate=2022-11-30&from_date=2022-10-31&to_date=2022-11-30"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final array[Long] orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

final array[RefundStatusType] statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

final ReturnType type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

final date fromDate = new date(); // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date toDate = new date(); // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date fromDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

final date toDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    final result = await api_instance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturns: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getReturns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
array[Long] *orderIds = ; // Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
array[RefundStatusType] *statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
ReturnType *type = ; // Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
date *fromDate = 2022-10-31; // Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *toDate = 2022-11-30; // Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *fromDate2 = 2022-10-31; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
date *toDate2 = 2022-11-30; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

// Список невыкупов и возвратов
[apiInstance getReturnsWith:campaignId
    pageToken:pageToken
    limit:limit
    orderIds:orderIds
    statuses:statuses
    type:type
    fromDate:fromDate
    toDate:toDate
    fromDate2:fromDate2
    toDate2:toDate2
              completionHandler: ^(GetReturnsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'orderIds': , // {array[Long]} Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

  'statuses': STARTED_BY_USER,WAITING_FOR_DECISION, // {array[RefundStatusType]} Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

  'type': , // {ReturnType} Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

  'fromDate': 2022-10-31, // {date} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'toDate': 2022-11-30, // {date} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'fromDate2': 2022-10-31, // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

  'toDate2': 2022-11-30 // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturns(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional)  (default to null)
            var statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional)  (default to null)
            var type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional)  (default to null)
            var fromDate = 2022-10-31;  // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var toDate = 2022-11-30;  // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var fromDate2 = 2022-10-31;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)
            var toDate2 = 2022-11-30;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)

            try {
                // Список невыкупов и возвратов
                GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getReturns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

$type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

$fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

$toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    $result = $api_instance->getReturns($campaignId, $pageToken, $limit, $orderIds, $statuses, $type, $fromDate, $toDate, $fromDate2, $toDate2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getReturns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $orderIds = []; # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

my $statuses = [STARTED_BY_USER,WAITING_FOR_DECISION]; # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

my $type = ; # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

my $fromDate = 2022-10-31; # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $toDate = 2022-11-30; # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $fromDate2 = 2022-10-31; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

my $toDate2 = 2022-11-30; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


eval {
    my $result = $api_instance->getReturns(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, orderIds => $orderIds, statuses => $statuses, type => $type, fromDate => $fromDate, toDate => $toDate, fromDate2 => $fromDate2, toDate2 => $toDate2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getReturns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
orderIds =  # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
statuses = STARTED_BY_USER,WAITING_FOR_DECISION # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
type =  # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
fromDate = 2022-10-31 # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
toDate = 2022-11-30 # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
fromDate2 = 2022-10-31 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
toDate2 = 2022-11-30 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

try:
    # Список невыкупов и возвратов
    api_response = api_instance.get_returns(campaignId, pageToken=pageToken, limit=limit, orderIds=orderIds, statuses=statuses, type=type, fromDate=fromDate, toDate=toDate, fromDate2=fromDate2, toDate2=toDate2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getReturns: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let orderIds = ; // array[Long]
    let statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType]
    let type = ; // ReturnType
    let fromDate = 2022-10-31; // date
    let toDate = 2022-11-30; // date
    let fromDate2 = 2022-10-31; // date
    let toDate2 = 2022-11-30; // date

    let mut context = FbsApi::Context::default();
    let result = client.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
orderIds
array[Long] (int64)
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
statuses
array[RefundStatusType]
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
type
ReturnType
Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.
fromDate
date (date)
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
toDate
date (date)
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
from_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `fromDate`. {% endnote %} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
to_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `toDate`. {% endnote %} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Responses


getShipment

Получение информации об одной отгрузке

Возвращает информацию об отгрузке по ее идентификатору. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}?cancelledOrders=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        Boolean cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


        try {
            GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final Boolean cancelledOrders = new Boolean(); // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


try {
    final result = await api_instance.getShipment(campaignId, shipmentId, cancelledOrders);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getShipment: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        Boolean cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


        try {
            GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
Boolean *cancelledOrders = true; // Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional) (default to true)

// Получение информации об одной отгрузке
[apiInstance getShipmentWith:campaignId
    shipmentId:shipmentId
    cancelledOrders:cancelledOrders
              completionHandler: ^(GetShipmentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'cancelledOrders': true // {Boolean} Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShipment(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var cancelledOrders = true;  // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional)  (default to true)

            try {
                // Получение информации об одной отгрузке
                GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


try {
    $result = $api_instance->getShipment($campaignId, $shipmentId, $cancelledOrders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $cancelledOrders = true; # Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


eval {
    my $result = $api_instance->getShipment(campaignId => $campaignId, shipmentId => $shipmentId, cancelledOrders => $cancelledOrders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
cancelledOrders = true # Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional) (default to true)

try:
    # Получение информации об одной отгрузке
    api_response = api_instance.get_shipment(campaignId, shipmentId, cancelledOrders=cancelledOrders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getShipment: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let cancelledOrders = true; // Boolean

    let mut context = FbsApi::Context::default();
    let result = client.getShipment(campaignId, shipmentId, cancelledOrders, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Query parameters
Name Description
cancelledOrders
Boolean
Возвращать ли отмененные заказы. Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.

Responses


getShipmentOrdersInfo

Получение информации о возможности печати ярлыков (FBS)

Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getShipmentOrdersInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.getShipmentOrdersInfo(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getShipmentOrdersInfo: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getShipmentOrdersInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение информации о возможности печати ярлыков (FBS)
[apiInstance getShipmentOrdersInfoWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(GetShipmentOrdersInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShipmentOrdersInfo(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getShipmentOrdersInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение информации о возможности печати ярлыков (FBS)
                GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getShipmentOrdersInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->getShipmentOrdersInfo($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getShipmentOrdersInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->getShipmentOrdersInfo(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getShipmentOrdersInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение информации о возможности печати ярлыков (FBS)
    api_response = api_instance.get_shipment_orders_info(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getShipmentOrdersInfo: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getShipmentOrdersInfo(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


getStocks

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для всех моделей) и об [оборачиваемости](*turnover) товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте `true` в поле `withTurnover`. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке Маркета для продавцов https://yandex.ru/support/marketplace/analytics/turnover.html.)


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "withTurnover" : false,
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetWarehouseStocksRequest getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest | 

try {
    final result = await api_instance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStocks: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetWarehouseStocksRequest *getWarehouseStocksRequest = ; //  (optional)

// Информация об остатках и оборачиваемости
[apiInstance getStocksWith:campaignId
    pageToken:pageToken
    limit:limit
    getWarehouseStocksRequest:getWarehouseStocksRequest
              completionHandler: ^(GetWarehouseStocksResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getWarehouseStocksRequest':  // {GetWarehouseStocksRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStocks(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest |  (optional) 

            try {
                // Информация об остатках и оборачиваемости
                GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

try {
    $result = $api_instance->getStocks($campaignId, $pageToken, $limit, $getWarehouseStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getWarehouseStocksRequest = WWW::OPenAPIClient::Object::GetWarehouseStocksRequest->new(); # GetWarehouseStocksRequest | 

eval {
    my $result = $api_instance->getStocks(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getWarehouseStocksRequest => $getWarehouseStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getWarehouseStocksRequest =  # GetWarehouseStocksRequest |  (optional)

try:
    # Информация об остатках и оборачиваемости
    api_response = api_instance.get_stocks(campaignId, pageToken=pageToken, limit=limit, getWarehouseStocksRequest=getWarehouseStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getStocks: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getWarehouseStocksRequest = ; // GetWarehouseStocksRequest

    let mut context = FbsApi::Context::default();
    let result = client.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getWarehouseStocksRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappingEntries

Рекомендованные карточки для товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/suggestions](../../reference/business-assortment/getSuggestedOfferMappings.md). {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/updates](../../reference/offer-mappings/updateOfferMappingEntries.md). В одном запросе можно получить не более 500 рекомендаций. |**⚙️ Лимит:** 100 000 рекомендаций в час| |-|


/campaigns/{campaignId}/offer-mapping-entries/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions" \
 -d '{
  "offers" : [ {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingEntriesRequest *getSuggestedOfferMappingEntriesRequest = ; // 

// Рекомендованные карточки для товаров
[apiInstance getSuggestedOfferMappingEntriesWith:campaignId
    getSuggestedOfferMappingEntriesRequest:getSuggestedOfferMappingEntriesRequest
              completionHandler: ^(GetSuggestedOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getSuggestedOfferMappingEntriesRequest = ; // {GetSuggestedOfferMappingEntriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

            try {
                // Рекомендованные карточки для товаров
                GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getSuggestedOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappingEntries($campaignId, $getSuggestedOfferMappingEntriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getSuggestedOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingEntriesRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingEntriesRequest->new(); # GetSuggestedOfferMappingEntriesRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappingEntries(campaignId => $campaignId, getSuggestedOfferMappingEntriesRequest => $getSuggestedOfferMappingEntriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getSuggestedOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingEntriesRequest =  # GetSuggestedOfferMappingEntriesRequest | 

try:
    # Рекомендованные карточки для товаров
    api_response = api_instance.get_suggested_offer_mapping_entries(campaignId, getSuggestedOfferMappingEntriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getSuggestedOfferMappingEntries: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest

    let mut context = FbsApi::Context::default();
    let result = client.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingEntriesRequest *

Responses


getSuggestedOfferMappings

Просмотр карточек на Маркете, которые подходят вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами. Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным. **Как пользоваться запросом** 1. Передайте Маркету список товаров, которые нужно проверить. 2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией. 3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида `https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>`. 4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать `marketSKU`, который ему подходит по вашему мнению. {% note info "𝓠 Как определить `marketSku` товара, найденного на Маркете?" %} 𝓐 Он есть в адресе страницы товара — расположен после `sku=`. Например, `https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016` {% endnote %} |**⚙️ Лимит:** 100 000 товаров в час| |-|


/businesses/{businessId}/offer-mappings/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/suggestions" \
 -d '{
  "offers" : [ {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingsRequest *getSuggestedOfferMappingsRequest = ; //  (optional)

// Просмотр карточек на Маркете, которые подходят вашим товарам
[apiInstance getSuggestedOfferMappingsWith:businessId
    getSuggestedOfferMappingsRequest:getSuggestedOfferMappingsRequest
              completionHandler: ^(GetSuggestedOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getSuggestedOfferMappingsRequest':  // {GetSuggestedOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest |  (optional) 

            try {
                // Просмотр карточек на Маркете, которые подходят вашим товарам
                GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getSuggestedOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappings($businessId, $getSuggestedOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getSuggestedOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingsRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingsRequest->new(); # GetSuggestedOfferMappingsRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappings(businessId => $businessId, getSuggestedOfferMappingsRequest => $getSuggestedOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getSuggestedOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingsRequest =  # GetSuggestedOfferMappingsRequest |  (optional)

try:
    # Просмотр карточек на Маркете, которые подходят вашим товарам
    api_response = api_instance.get_suggested_offer_mappings(businessId, getSuggestedOfferMappingsRequest=getSuggestedOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getSuggestedOfferMappings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest

    let mut context = FbsApi::Context::default();
    let result = client.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingsRequest

Responses


getSuggestedPrices

Цены для продвижения товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [отчет «Цены на рынке»](../../reference/reports/generatePricesReport.md). {% endnote %} {% note warning "" %} Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях. {% endnote %} Возвращает цены для продвижения товаров, которые вы размещаете на Маркете. Товары, для которых нужно получить цены, передаются в теле POST-запроса. Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене. Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения. Установить цены на товары можно с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md) или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете. Подробно об автоматическом управлении ценами рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/prices.html). |**⚙️ Лимит:** 100 000 товаров в час| |-|


/campaigns/{campaignId}/offer-prices/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions" \
 -d '{
  "offers" : [ {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SuggestPricesRequest suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

try {
    final result = await api_instance.getSuggestedPrices(campaignId, suggestPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedPrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SuggestPricesRequest *suggestPricesRequest = ; // 

// Цены для продвижения товаров
[apiInstance getSuggestedPricesWith:campaignId
    suggestPricesRequest:suggestPricesRequest
              completionHandler: ^(SuggestPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var suggestPricesRequest = ; // {SuggestPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedPrices(campaignId, suggestPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

            try {
                // Цены для продвижения товаров
                SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getSuggestedPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$suggestPricesRequest = ; // SuggestPricesRequest | 

try {
    $result = $api_instance->getSuggestedPrices($campaignId, $suggestPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getSuggestedPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $suggestPricesRequest = WWW::OPenAPIClient::Object::SuggestPricesRequest->new(); # SuggestPricesRequest | 

eval {
    my $result = $api_instance->getSuggestedPrices(campaignId => $campaignId, suggestPricesRequest => $suggestPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getSuggestedPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
suggestPricesRequest =  # SuggestPricesRequest | 

try:
    # Цены для продвижения товаров
    api_response = api_instance.get_suggested_prices(campaignId, suggestPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getSuggestedPrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let suggestPricesRequest = ; // SuggestPricesRequest

    let mut context = FbsApi::Context::default();
    let result = client.getSuggestedPrices(campaignId, suggestPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
suggestPricesRequest *

Responses


getWarehouses

Список складов и групп складов

Возвращает список складов и, если склады объединены, список групп складов. [Что такое группы складов и зачем они нужны](https://yandex.ru/support/marketplace/assortment/operations/stocks.html#unified-stocks) Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getWarehouses(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getWarehouses: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список складов и групп складов
[apiInstance getWarehousesWith:businessId
              completionHandler: ^(GetWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouses(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список складов и групп складов
                GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.getWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getWarehouses($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getWarehouses(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->getWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список складов и групп складов
    api_response = api_instance.get_warehouses(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->getWarehouses: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.getWarehouses(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


provideOrderItemIdentifiers

Передача кодов маркировки единиц товара

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Передает Маркету коды маркировки для единиц товара в указанном заказе. Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. {% note warning %} Прежде чем работать с этим методом, обязательно прочтите [статью о работе с маркируемыми товарами](https://yandex.ru/support/marketplace/orders/cz.html). {% endnote %} Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/identifiers

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers" \
 -d '{
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

try {
    final result = await api_instance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderItemIdentifiers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderItemIdentifiersRequest *provideOrderItemIdentifiersRequest = ; // 

// Передача кодов маркировки единиц товара
[apiInstance provideOrderItemIdentifiersWith:campaignId
    orderId:orderId
    provideOrderItemIdentifiersRequest:provideOrderItemIdentifiersRequest
              completionHandler: ^(ProvideOrderItemIdentifiersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderItemIdentifiersRequest = ; // {ProvideOrderItemIdentifiersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderItemIdentifiersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

            try {
                // Передача кодов маркировки единиц товара
                ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.provideOrderItemIdentifiers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

try {
    $result = $api_instance->provideOrderItemIdentifiers($campaignId, $orderId, $provideOrderItemIdentifiersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->provideOrderItemIdentifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderItemIdentifiersRequest = WWW::OPenAPIClient::Object::ProvideOrderItemIdentifiersRequest->new(); # ProvideOrderItemIdentifiersRequest | 

eval {
    my $result = $api_instance->provideOrderItemIdentifiers(campaignId => $campaignId, orderId => $orderId, provideOrderItemIdentifiersRequest => $provideOrderItemIdentifiersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->provideOrderItemIdentifiers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderItemIdentifiersRequest =  # ProvideOrderItemIdentifiersRequest | 

try:
    # Передача кодов маркировки единиц товара
    api_response = api_instance.provide_order_item_identifiers(campaignId, orderId, provideOrderItemIdentifiersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->provideOrderItemIdentifiers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest

    let mut context = FbsApi::Context::default();
    let result = client.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderItemIdentifiersRequest *

Responses


putBidsForBusiness

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} ![](../../_images/api-boost.png) {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForBusiness(businessId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForBusiness: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок
[apiInstance putBidsForBusinessWith:businessId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForBusiness(businessId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок
                EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.putBidsForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForBusiness($businessId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForBusiness(businessId => $businessId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->putBidsForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок
    api_response = api_instance.put_bids_for_business(businessId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->putBidsForBusiness: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = FbsApi::Context::default();
    let result = client.putBidsForBusiness(businessId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


putBidsForCampaign

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или [PUT businesses/{businessId}/bids](/reference/bids/putBidsForBusiness). Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/campaigns/{campaignId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForCampaign(campaignId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForCampaign: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок для магазина
[apiInstance putBidsForCampaignWith:campaignId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForCampaign(campaignId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок для магазина
                EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.putBidsForCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForCampaign($campaignId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForCampaign(campaignId => $campaignId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->putBidsForCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок для магазина
    api_response = api_instance.put_bids_for_campaign(campaignId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->putBidsForCampaign: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = FbsApi::Context::default();
    let result = client.putBidsForCampaign(campaignId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


refreshFeed

Сообщить, что прайс-лист обновился

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом `POST campaigns/{campaignId}/feeds/{feedId}/refresh`. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — `200 OK`. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.refreshFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshFeed: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Сообщить, что прайс-лист обновился
[apiInstance refreshFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class refreshFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Сообщить, что прайс-лист обновился
                EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.refreshFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->refreshFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->refreshFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->refreshFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Сообщить, что прайс-лист обновился
    api_response = api_instance.refresh_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->refreshFeed: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.refreshFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


searchRegionChildren

Информация о дочерних регионах

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}/children

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}/children?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchRegionChildren(regionId, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionChildren: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о дочерних регионах
[apiInstance searchRegionChildrenWith:regionId
    page:page
    pageSize:pageSize
              completionHandler: ^(GetRegionWithChildrenResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionChildren(regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionChildrenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о дочерних регионах
                GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.searchRegionChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchRegionChildren($regionId, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->searchRegionChildren: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchRegionChildren(regionId => $regionId, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->searchRegionChildren: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о дочерних регионах
    api_response = api_instance.search_region_children(regionId, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->searchRegionChildren: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let regionId = 789; // Long
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.searchRegionChildren(regionId, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionsById

Информация о регионе

Возвращает информацию о регионе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    final result = await api_instance.searchRegionsById(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsById: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

// Информация о регионе
[apiInstance searchRegionsByIdWith:regionId
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsById(regionId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

            try {
                // Информация о регионе
                GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.searchRegionsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    $result = $api_instance->searchRegionsById($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->searchRegionsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


eval {
    my $result = $api_instance->searchRegionsById(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->searchRegionsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

try:
    # Информация о регионе
    api_response = api_instance.search_regions_by_id(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->searchRegionsById: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let regionId = 789; // Long

    let mut context = FbsApi::Context::default();
    let result = client.searchRegionsById(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required

Responses


searchRegionsByName

Поиск регионов по их имени

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска. Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions?name=name_example&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchRegionsByName(name, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsByName: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
String *name = name_example; // Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Поиск регионов по их имени
[apiInstance searchRegionsByNameWith:name
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var name = name_example; // {String} Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsByName(name, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByNameExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var name = name_example;  // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Поиск регионов по их имени
                GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.searchRegionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchRegionsByName($name, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->searchRegionsByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $name = name_example; # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchRegionsByName(name => $name, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->searchRegionsByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
name = name_example # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Поиск регионов по их имени
    api_response = api_instance.search_regions_by_name(name, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->searchRegionsByName: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let name = name_example; // String
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.searchRegionsByName(name, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
name*
String
Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


searchShipments

Получение информации о нескольких отгрузках

Возвращает информацию об отгрузках по заданным параметрам: * дате; * статусу; * идентификаторам заказов. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cancelledOrders" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "OUTBOUND_CREATED", "OUTBOUND_CREATED" ],
  "orderIds" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SearchShipmentsRequest searchShipmentsRequest = ; // SearchShipmentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchShipments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SearchShipmentsRequest searchShipmentsRequest = new SearchShipmentsRequest(); // SearchShipmentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchShipments: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SearchShipmentsRequest searchShipmentsRequest = ; // SearchShipmentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#searchShipments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SearchShipmentsRequest *searchShipmentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение информации о нескольких отгрузках
[apiInstance searchShipmentsWith:campaignId
    searchShipmentsRequest:searchShipmentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(SearchShipmentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var searchShipmentsRequest = ; // {SearchShipmentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchShipments(campaignId, searchShipmentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchShipmentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var searchShipmentsRequest = new SearchShipmentsRequest(); // SearchShipmentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение информации о нескольких отгрузках
                SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.searchShipments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$searchShipmentsRequest = ; // SearchShipmentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchShipments($campaignId, $searchShipmentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->searchShipments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $searchShipmentsRequest = WWW::OPenAPIClient::Object::SearchShipmentsRequest->new(); # SearchShipmentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchShipments(campaignId => $campaignId, searchShipmentsRequest => $searchShipmentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->searchShipments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
searchShipmentsRequest =  # SearchShipmentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение информации о нескольких отгрузках
    api_response = api_instance.search_shipments(campaignId, searchShipmentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->searchShipments: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let searchShipmentsRequest = ; // SearchShipmentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbsApi::Context::default();
    let result = client.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
searchShipmentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


sendFileToChat

Отправка файла в чат

Отправляет файл в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/file/send

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/file/send?chatId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final File file = new File(); // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    final result = await api_instance.sendFileToChat(businessId, chatId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendFileToChat: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
File *file = BINARY_DATA_HERE; // Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

// Отправка файла в чат
[apiInstance sendFileToChatWith:businessId
    chatId:chatId
    file:file
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var file = BINARY_DATA_HERE; // {File} Содержимое файла. Максимальный размер файла — 5 Мбайт.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFileToChat(businessId, chatId, file, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendFileToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var file = BINARY_DATA_HERE;  // File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

            try {
                // Отправка файла в чат
                EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.sendFileToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $api_instance->sendFileToChat($businessId, $chatId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $file = BINARY_DATA_HERE; # File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

eval {
    my $result = $api_instance->sendFileToChat(businessId => $businessId, chatId => $chatId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->sendFileToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
file = BINARY_DATA_HERE # File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

try:
    # Отправка файла в чат
    api_response = api_instance.send_file_to_chat(businessId, chatId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->sendFileToChat: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = FbsApi::Context::default();
    let result = client.sendFileToChat(businessId, chatId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Form parameters
Name Description
file*
File (binary)
Содержимое файла. Максимальный размер файла — 5 Мбайт.
Required
Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


sendMessageToChat

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/message

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/message?chatId=789" \
 -d '{
  "message" : "message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final SendMessageToChatRequest sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

try {
    final result = await api_instance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendMessageToChat: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
SendMessageToChatRequest *sendMessageToChatRequest = ; // 

// Отправка сообщения в чат
[apiInstance sendMessageToChatWith:businessId
    chatId:chatId
    sendMessageToChatRequest:sendMessageToChatRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var sendMessageToChatRequest = ; // {SendMessageToChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendMessageToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

            try {
                // Отправка сообщения в чат
                EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.sendMessageToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$sendMessageToChatRequest = ; // SendMessageToChatRequest | 

try {
    $result = $api_instance->sendMessageToChat($businessId, $chatId, $sendMessageToChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $sendMessageToChatRequest = WWW::OPenAPIClient::Object::SendMessageToChatRequest->new(); # SendMessageToChatRequest | 

eval {
    my $result = $api_instance->sendMessageToChat(businessId => $businessId, chatId => $chatId, sendMessageToChatRequest => $sendMessageToChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->sendMessageToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
sendMessageToChatRequest =  # SendMessageToChatRequest | 

try:
    # Отправка сообщения в чат
    api_response = api_instance.send_message_to_chat(businessId, chatId, sendMessageToChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->sendMessageToChat: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let sendMessageToChatRequest = ; // SendMessageToChatRequest

    let mut context = FbsApi::Context::default();
    let result = client.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
sendMessageToChatRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


setFeedParams

Изменение параметров прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: `name` (название параметра) и `value` (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: `name` (название параметра) и `delete=true` (удалить значение). |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/params

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/params" \
 -d '{
  "parameters" : [ {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  }, {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final SetFeedParamsRequest setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

try {
    final result = await api_instance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setFeedParams: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
SetFeedParamsRequest *setFeedParamsRequest = ; // 

// Изменение параметров прайс-листа
[apiInstance setFeedParamsWith:campaignId
    feedId:feedId
    setFeedParamsRequest:setFeedParamsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var setFeedParamsRequest = ; // {SetFeedParamsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFeedParams(campaignId, feedId, setFeedParamsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setFeedParamsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

            try {
                // Изменение параметров прайс-листа
                EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.setFeedParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$setFeedParamsRequest = ; // SetFeedParamsRequest | 

try {
    $result = $api_instance->setFeedParams($campaignId, $feedId, $setFeedParamsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $setFeedParamsRequest = WWW::OPenAPIClient::Object::SetFeedParamsRequest->new(); # SetFeedParamsRequest | 

eval {
    my $result = $api_instance->setFeedParams(campaignId => $campaignId, feedId => $feedId, setFeedParamsRequest => $setFeedParamsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->setFeedParams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
setFeedParamsRequest =  # SetFeedParamsRequest | 

try:
    # Изменение параметров прайс-листа
    api_response = api_instance.set_feed_params(campaignId, feedId, setFeedParamsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->setFeedParams: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let setFeedParamsRequest = ; // SetFeedParamsRequest

    let mut context = FbsApi::Context::default();
    let result = client.setFeedParams(campaignId, feedId, setFeedParamsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Body parameters
Name Description
setFeedParamsRequest *

Responses


setOrderBoxLayout

Подготовка заказа

{% note tip "Подходит и для DBS" %} Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно. {% endnote %} Позволяет выполнить три операции: * передать Маркету информацию о распределении товаров по коробкам; * передать Маркету коды маркировки для товаров; * удалить товар из заказа, если его не оказалось на складе. Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус **Готов к отгрузке**. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново. ## Как передать информацию о распределении товаров В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов: * **Содержащие товары целиком.** Такая коробка может содержать сколько угодно единиц любых товаров. * **Содержащие часть товара.** Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок. ⚠️ Одна коробка не может содержать и товары целиком, и части товаров. ## Как передавать коды маркировки Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. [Что такое маркировка?](https://yandex.ru/support/marketplace/orders/cz.html) Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них. ## Как удалить товар из заказа Чтобы удалить товар из заказа: 1. Добавьте в запрос `allowRemove: true`. 2. Передайте распределение по коробкам без товара, который нужно удалить. {% note warning "Удаление нельзя отменить" %} Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится. {% endnote %} Чтобы удалить позицию целиком, не передавайте соответствующий `OrderBoxLayoutItemDTO`. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле `fullCount`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} ## Примеры {% cut "Товар умещается в коробку" %} Вот как будет выглядеть запрос, если в одной коробке едут: * три единицы одного товара, требующего маркировки; * одна единица другого товара, не требущего маркировки. ```json { "boxes": [ { "items": [ { "id": 123456, "fullCount": 3, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" }, { "cis": "010304109478gftJ14545762!\u001dhGt264" }, { "cis": "010304109478fRs28323ks23!\u001dhet201" } ] }, { "id": 654321, "fullCount": 1 } ] } ] } ``` {% endcut %} {% cut "Товар едет в разных коробках" %} Вот как будет выглядеть запрос, если товар едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} {% cut "Одинаковые товары, где каждый едет в нескольких коробках" %} Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/boxes" \
 -d '{
  "boxes" : [ {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  }, {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  } ],
  "allowRemove" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

try {
    final result = await api_instance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderBoxLayout: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderBoxLayoutRequest *setOrderBoxLayoutRequest = ; // 

// Подготовка заказа
[apiInstance setOrderBoxLayoutWith:campaignId
    orderId:orderId
    setOrderBoxLayoutRequest:setOrderBoxLayoutRequest
              completionHandler: ^(SetOrderBoxLayoutResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderBoxLayoutRequest = ; // {SetOrderBoxLayoutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderBoxLayoutExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

            try {
                // Подготовка заказа
                SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.setOrderBoxLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

try {
    $result = $api_instance->setOrderBoxLayout($campaignId, $orderId, $setOrderBoxLayoutRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->setOrderBoxLayout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderBoxLayoutRequest = WWW::OPenAPIClient::Object::SetOrderBoxLayoutRequest->new(); # SetOrderBoxLayoutRequest | 

eval {
    my $result = $api_instance->setOrderBoxLayout(campaignId => $campaignId, orderId => $orderId, setOrderBoxLayoutRequest => $setOrderBoxLayoutRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->setOrderBoxLayout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderBoxLayoutRequest =  # SetOrderBoxLayoutRequest | 

try:
    # Подготовка заказа
    api_response = api_instance.set_order_box_layout(campaignId, orderId, setOrderBoxLayoutRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->setOrderBoxLayout: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest

    let mut context = FbsApi::Context::default();
    let result = client.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderBoxLayoutRequest *

Responses


setOrderShipmentBoxes

Передача количества грузовых мест в заказе

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест. Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус **Готов к отгрузке**. Подробно о том, что в какой момент нужно передавать, рассказано в [пошаговой инструкции](../../step-by-step/fbs.md). Метод устроен немного нестандартно: количество задается длиной массива пустых объектов. Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому. {% cut "Как было раньше" %} Структура тела PUT-запроса: ``` { "boxes": [ { "fulfilmentId": "{string}", "weight": {int64}, "width": {int64}, "height": {int64}, "depth": {int64}, "items": [ { "id": {int64}, "count": {int32} }, ... ] }, ... ] } ``` | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `boxes` | | Список грузовых мест. | **Параметры, вложенные в `boxes`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `fulfilmentId` | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: `номер заказа на Маркете-номер грузового места`. Например, `7206821‑1, 7206821‑2` и т. д. | | `weight` | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | `width` | Int64 | Ширина грузового места в сантиметрах. | | `height` | Int64 | Высота грузового места в сантиметрах. | | `depth` | Int64 | Глубина грузового места в сантиметрах. | | `items` | Int64 | Список товаров в грузовом месте. | **Параметры, вложенные в `items`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `id` | Int64 | Идентификатор товара в рамках заказа. | | `count` | Int32 | Количество единиц товара в грузовом месте. | {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes" \
 -d '{
  "boxes" : [ {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  }, {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

final SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

try {
    final result = await api_instance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderShipmentBoxes: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
SetOrderShipmentBoxesRequest *setOrderShipmentBoxesRequest = ; // 

// Передача количества грузовых мест в заказе
[apiInstance setOrderShipmentBoxesWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    setOrderShipmentBoxesRequest:setOrderShipmentBoxesRequest
              completionHandler: ^(SetOrderShipmentBoxesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

var setOrderShipmentBoxesRequest = ; // {SetOrderShipmentBoxesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderShipmentBoxesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
            var setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

            try {
                // Передача количества грузовых мест в заказе
                SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.setOrderShipmentBoxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

$setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

try {
    $result = $api_instance->setOrderShipmentBoxes($campaignId, $orderId, $shipmentId, $setOrderShipmentBoxesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->setOrderShipmentBoxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

my $setOrderShipmentBoxesRequest = WWW::OPenAPIClient::Object::SetOrderShipmentBoxesRequest->new(); # SetOrderShipmentBoxesRequest | 

eval {
    my $result = $api_instance->setOrderShipmentBoxes(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, setOrderShipmentBoxesRequest => $setOrderShipmentBoxesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->setOrderShipmentBoxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
setOrderShipmentBoxesRequest =  # SetOrderShipmentBoxesRequest | 

try:
    # Передача количества грузовых мест в заказе
    api_response = api_instance.set_order_shipment_boxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->setOrderShipmentBoxes: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest

    let mut context = FbsApi::Context::default();
    let result = client.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
Required
Body parameters
Name Description
setOrderShipmentBoxesRequest *

Responses


setShipmentPalletsCount

Передача количества упаковок в отгрузке

Передает Маркету количество коробов или палет в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в [Справке Маркета](https://yandex.ru/support/marketplace/orders/fbs/process.html#acceptance). Получить PDF-файл с ярлыками для упаковок можно с помощью запроса [GET campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels](../../reference/shipments/downloadShipmentPalletLabels.md). |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets" \
 -d '{
  "placesCount" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

        try {
            EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setShipmentPalletsCount");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = new SetShipmentPalletsCountRequest(); // SetShipmentPalletsCountRequest | 

try {
    final result = await api_instance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setShipmentPalletsCount: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

        try {
            EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#setShipmentPalletsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
SetShipmentPalletsCountRequest *setShipmentPalletsCountRequest = ; // 

// Передача количества упаковок в отгрузке
[apiInstance setShipmentPalletsCountWith:campaignId
    shipmentId:shipmentId
    setShipmentPalletsCountRequest:setShipmentPalletsCountRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var setShipmentPalletsCountRequest = ; // {SetShipmentPalletsCountRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setShipmentPalletsCountExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var setShipmentPalletsCountRequest = new SetShipmentPalletsCountRequest(); // SetShipmentPalletsCountRequest | 

            try {
                // Передача количества упаковок в отгрузке
                EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.setShipmentPalletsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

try {
    $result = $api_instance->setShipmentPalletsCount($campaignId, $shipmentId, $setShipmentPalletsCountRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->setShipmentPalletsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $setShipmentPalletsCountRequest = WWW::OPenAPIClient::Object::SetShipmentPalletsCountRequest->new(); # SetShipmentPalletsCountRequest | 

eval {
    my $result = $api_instance->setShipmentPalletsCount(campaignId => $campaignId, shipmentId => $shipmentId, setShipmentPalletsCountRequest => $setShipmentPalletsCountRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->setShipmentPalletsCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
setShipmentPalletsCountRequest =  # SetShipmentPalletsCountRequest | 

try:
    # Передача количества упаковок в отгрузке
    api_response = api_instance.set_shipment_pallets_count(campaignId, shipmentId, setShipmentPalletsCountRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->setShipmentPalletsCount: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest

    let mut context = FbsApi::Context::default();
    let result = client.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
setShipmentPalletsCountRequest *

Responses


skipGoodsFeedbacksReaction

Отказ от ответа на отзывы

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов [POST businesses/{businessId}/goods-feedback](../../reference/goods-feedback/getGoodsFeedbacks.md). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/skip-reaction

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/skip-reaction" \
 -d '{
  "feedbackIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

try {
    final result = await api_instance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->skipGoodsFeedbacksReaction: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SkipGoodsFeedbackReactionRequest *skipGoodsFeedbackReactionRequest = ; // 

// Отказ от ответа на отзывы
[apiInstance skipGoodsFeedbacksReactionWith:businessId
    skipGoodsFeedbackReactionRequest:skipGoodsFeedbackReactionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var skipGoodsFeedbackReactionRequest = ; // {SkipGoodsFeedbackReactionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class skipGoodsFeedbacksReactionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

            try {
                // Отказ от ответа на отзывы
                EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.skipGoodsFeedbacksReaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

try {
    $result = $api_instance->skipGoodsFeedbacksReaction($businessId, $skipGoodsFeedbackReactionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->skipGoodsFeedbacksReaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $skipGoodsFeedbackReactionRequest = WWW::OPenAPIClient::Object::SkipGoodsFeedbackReactionRequest->new(); # SkipGoodsFeedbackReactionRequest | 

eval {
    my $result = $api_instance->skipGoodsFeedbacksReaction(businessId => $businessId, skipGoodsFeedbackReactionRequest => $skipGoodsFeedbackReactionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->skipGoodsFeedbacksReaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
skipGoodsFeedbackReactionRequest =  # SkipGoodsFeedbackReactionRequest | 

try:
    # Отказ от ответа на отзывы
    api_response = api_instance.skip_goods_feedbacks_reaction(businessId, skipGoodsFeedbackReactionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->skipGoodsFeedbacksReaction: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest

    let mut context = FbsApi::Context::default();
    let result = client.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
skipGoodsFeedbackReactionRequest *

Responses


transferOrdersFromShipment

Перенос заказов в следующую отгрузку

Переносит указанные заказы из указанной отгрузки в следующую отгрузку. [Что такое отгрузка?](https://yandex.ru/support/marketplace/orders/fbs/process.html#ship) Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя. {% note warning "Такие переносы снижают индекс качества магазина" %} Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. [Что за ограничения?](https://yandex.ru/support/marketplace/quality/score/fbs.html) {% endnote %} Переносить заказы можно, если до формирования отгрузки осталось больше получаса. Перенос происходит не мгновенно, а занимает несколько минут. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer" \
 -d '{
  "orderIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#transferOrdersFromShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = new TransferOrdersFromShipmentRequest(); // TransferOrdersFromShipmentRequest | 

try {
    final result = await api_instance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->transferOrdersFromShipment: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#transferOrdersFromShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
TransferOrdersFromShipmentRequest *transferOrdersFromShipmentRequest = ; // 

// Перенос заказов в следующую отгрузку
[apiInstance transferOrdersFromShipmentWith:campaignId
    shipmentId:shipmentId
    transferOrdersFromShipmentRequest:transferOrdersFromShipmentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var transferOrdersFromShipmentRequest = ; // {TransferOrdersFromShipmentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class transferOrdersFromShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var transferOrdersFromShipmentRequest = new TransferOrdersFromShipmentRequest(); // TransferOrdersFromShipmentRequest | 

            try {
                // Перенос заказов в следующую отгрузку
                EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.transferOrdersFromShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

try {
    $result = $api_instance->transferOrdersFromShipment($campaignId, $shipmentId, $transferOrdersFromShipmentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->transferOrdersFromShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $transferOrdersFromShipmentRequest = WWW::OPenAPIClient::Object::TransferOrdersFromShipmentRequest->new(); # TransferOrdersFromShipmentRequest | 

eval {
    my $result = $api_instance->transferOrdersFromShipment(campaignId => $campaignId, shipmentId => $shipmentId, transferOrdersFromShipmentRequest => $transferOrdersFromShipmentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->transferOrdersFromShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
transferOrdersFromShipmentRequest =  # TransferOrdersFromShipmentRequest | 

try:
    # Перенос заказов в следующую отгрузку
    api_response = api_instance.transfer_orders_from_shipment(campaignId, shipmentId, transferOrdersFromShipmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->transferOrdersFromShipment: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest

    let mut context = FbsApi::Context::default();
    let result = client.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
transferOrdersFromShipmentRequest *

Responses


updateBusinessPrices

Установка цен на товары во всех магазинах

Устанавливает [базовые цены](*default-price). Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateBusinessPricesRequest updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

try {
    final result = await api_instance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateBusinessPrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateBusinessPricesRequest *updateBusinessPricesRequest = ; // 

// Установка цен на товары во всех магазинах
[apiInstance updateBusinessPricesWith:businessId
    updateBusinessPricesRequest:updateBusinessPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateBusinessPricesRequest = ; // {UpdateBusinessPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBusinessPrices(businessId, updateBusinessPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

            try {
                // Установка цен на товары во всех магазинах
                EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

try {
    $result = $api_instance->updateBusinessPrices($businessId, $updateBusinessPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateBusinessPricesRequest = WWW::OPenAPIClient::Object::UpdateBusinessPricesRequest->new(); # UpdateBusinessPricesRequest | 

eval {
    my $result = $api_instance->updateBusinessPrices(businessId => $businessId, updateBusinessPricesRequest => $updateBusinessPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateBusinessPricesRequest =  # UpdateBusinessPricesRequest | 

try:
    # Установка цен на товары во всех магазинах
    api_response = api_instance.update_business_prices(businessId, updateBusinessPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateBusinessPrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateBusinessPrices(businessId, updateBusinessPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateBusinessPricesRequest *

Responses


updateCampaignOffers

Изменение условий продажи товаров в магазине

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/update" \
 -d '{
  "offers" : [ {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateCampaignOffersRequest updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

try {
    final result = await api_instance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateCampaignOffersRequest *updateCampaignOffersRequest = ; // 

// Изменение условий продажи товаров в магазине
[apiInstance updateCampaignOffersWith:campaignId
    updateCampaignOffersRequest:updateCampaignOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateCampaignOffersRequest = ; // {UpdateCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCampaignOffers(campaignId, updateCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

            try {
                // Изменение условий продажи товаров в магазине
                EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

try {
    $result = $api_instance->updateCampaignOffers($campaignId, $updateCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateCampaignOffersRequest = WWW::OPenAPIClient::Object::UpdateCampaignOffersRequest->new(); # UpdateCampaignOffersRequest | 

eval {
    my $result = $api_instance->updateCampaignOffers(campaignId => $campaignId, updateCampaignOffersRequest => $updateCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateCampaignOffersRequest =  # UpdateCampaignOffersRequest | 

try:
    # Изменение условий продажи товаров в магазине
    api_response = api_instance.update_campaign_offers(campaignId, updateCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateCampaignOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateCampaignOffers(campaignId, updateCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateCampaignOffersRequest *

Responses


updateGoodsFeedbackComment

Добавление нового или изменение созданного комментария

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее. Для создания комментария к отзыву передайте только идентификатор отзыва `feedbackId`. Чтобы добавить комментарий к другому комментарию, передайте: * `feedbackId` — идентификатор отзыва; * `comment.parentId` — идентификатор родительского комментария. Чтобы изменить комментарий, передайте: * `feedbackId`— идентификатор отзыва; * `comment.id` — идентификатор комментария, который нужно изменить. Если передать одновременно `comment.parentId` и `comment.id`, будет изменен существующий комментарий. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/update" \
 -d '{
  "feedbackId" : 0,
  "comment" : {
    "id" : 6,
    "text" : "text",
    "parentId" : 1
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateGoodsFeedbackCommentRequest *updateGoodsFeedbackCommentRequest = ; // 

// Добавление нового или изменение созданного комментария
[apiInstance updateGoodsFeedbackCommentWith:businessId
    updateGoodsFeedbackCommentRequest:updateGoodsFeedbackCommentRequest
              completionHandler: ^(UpdateGoodsFeedbackCommentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateGoodsFeedbackCommentRequest = ; // {UpdateGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

            try {
                // Добавление нового или изменение созданного комментария
                UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->updateGoodsFeedbackComment($businessId, $updateGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::UpdateGoodsFeedbackCommentRequest->new(); # UpdateGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->updateGoodsFeedbackComment(businessId => $businessId, updateGoodsFeedbackCommentRequest => $updateGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateGoodsFeedbackCommentRequest =  # UpdateGoodsFeedbackCommentRequest | 

try:
    # Добавление нового или изменение созданного комментария
    api_response = api_instance.update_goods_feedback_comment(businessId, updateGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateGoodsFeedbackComment: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateGoodsFeedbackCommentRequest *

Responses


updateOfferContent

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Чтобы удалить характеристики, которые заданы в параметрах с типом `string`, передайте пустое значение. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/businesses/{businessId}/offer-cards/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards/update" \
 -d '{
  "offersContent" : [ {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferContentRequest updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

try {
    final result = await api_instance.updateOfferContent(businessId, updateOfferContentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferContent: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferContentRequest *updateOfferContentRequest = ; // 

// Редактирование категорийных характеристик товара
[apiInstance updateOfferContentWith:businessId
    updateOfferContentRequest:updateOfferContentRequest
              completionHandler: ^(UpdateOfferContentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferContentRequest = ; // {UpdateOfferContentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferContent(businessId, updateOfferContentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferContentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

            try {
                // Редактирование категорийных характеристик товара
                UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOfferContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferContentRequest = ; // UpdateOfferContentRequest | 

try {
    $result = $api_instance->updateOfferContent($businessId, $updateOfferContentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferContentRequest = WWW::OPenAPIClient::Object::UpdateOfferContentRequest->new(); # UpdateOfferContentRequest | 

eval {
    my $result = $api_instance->updateOfferContent(businessId => $businessId, updateOfferContentRequest => $updateOfferContentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOfferContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferContentRequest =  # UpdateOfferContentRequest | 

try:
    # Редактирование категорийных характеристик товара
    api_response = api_instance.update_offer_content(businessId, updateOfferContentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateOfferContent: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferContentRequest = ; // UpdateOfferContentRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOfferContent(businessId, updateOfferContentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferContentRequest *

Responses


updateOfferMappingEntries

Добавление и редактирование товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре `shopSku` ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре `shopSku` ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/suggestions](../../reference/offer-mappings/getSuggestedOfferMappingEntries.md) или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус `NEED_CONTENT` (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус `NEED_INFO` (в описании товара не хватает информации) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5 000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-mapping-entries/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/updates" \
 -d '{
  "offerMappingEntries" : [ {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

try {
    final result = await api_instance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingEntryRequest *updateOfferMappingEntryRequest = ; // 

// Добавление и редактирование товаров в каталоге
[apiInstance updateOfferMappingEntriesWith:campaignId
    updateOfferMappingEntryRequest:updateOfferMappingEntryRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingEntryRequest = ; // {UpdateOfferMappingEntryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

            try {
                // Добавление и редактирование товаров в каталоге
                EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

try {
    $result = $api_instance->updateOfferMappingEntries($campaignId, $updateOfferMappingEntryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingEntryRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingEntryRequest->new(); # UpdateOfferMappingEntryRequest | 

eval {
    my $result = $api_instance->updateOfferMappingEntries(campaignId => $campaignId, updateOfferMappingEntryRequest => $updateOfferMappingEntryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingEntryRequest =  # UpdateOfferMappingEntryRequest | 

try:
    # Добавление и редактирование товаров в каталоге
    api_response = api_instance.update_offer_mapping_entries(campaignId, updateOfferMappingEntryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateOfferMappingEntries: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingEntryRequest *

Responses


updateOfferMappings

Добавление товаров в каталог и изменение информации о них

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах. Список категорий Маркета можно получить с помощью запроса [POST categories/tree](../../reference/categories/getCategoriesTree.md), а характеристики товаров по категориям с помощью [POST category/{categoryId}/parameters](../../reference/content/getCategoryContentParameters.md). Чтобы **добавить новый товар**, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (**SKU на Маркете**) в поле `marketSKU`. Для **новых товаров** обязательно укажите параметры: `offerId`, `name`, `marketCategoryId` или `category`, `pictures`, `vendor`, `description`. Чтобы **отредактировать информацию о товаре**, передайте новые данные, указав в `offerId` соответствующий **ваш SKU**. Поля, в которых ничего не меняется, можно не передавать. Чтобы **удалить характеристики**, которые заданы в параметрах с типом `string`, передайте пустое значение. Параметр `offerId` должен быть **уникальным** для всех товаров, которые вы передаете. {% note warning "Правила использования SKU" %} * У каждого товара SKU должен быть свой. * SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. * Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update" \
 -d '{
  "offerMappings" : [ {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  } ],
  "onlyPartnerMediaContent" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingsRequest updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

try {
    final result = await api_instance.updateOfferMappings(businessId, updateOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappings: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingsRequest *updateOfferMappingsRequest = ; // 

// Добавление товаров в каталог и изменение информации о них
[apiInstance updateOfferMappingsWith:businessId
    updateOfferMappingsRequest:updateOfferMappingsRequest
              completionHandler: ^(UpdateOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingsRequest = ; // {UpdateOfferMappingsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappings(businessId, updateOfferMappingsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

            try {
                // Добавление товаров в каталог и изменение информации о них
                UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

try {
    $result = $api_instance->updateOfferMappings($businessId, $updateOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingsRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingsRequest->new(); # UpdateOfferMappingsRequest | 

eval {
    my $result = $api_instance->updateOfferMappings(businessId => $businessId, updateOfferMappingsRequest => $updateOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingsRequest =  # UpdateOfferMappingsRequest | 

try:
    # Добавление товаров в каталог и изменение информации о них
    api_response = api_instance.update_offer_mappings(businessId, updateOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateOfferMappings: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOfferMappings(businessId, updateOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingsRequest *

Responses


updateOrderItems

Удаление товара из заказа или уменьшение числа единиц

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях: * покупатель уменьшил количество товара; * магазин не может поставить все товары в заказе. Для этого заказ должен находится в статусе `"status": "PROCESSING"` этапа обработки `"substatus": "STARTED"`. После передачи статуса `"substatus": "READY_TO_SHIP"` изменить состав невозможно. Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте `count` параметра `item`. Чтобы полностью удалить товар из заказа: * передайте значение `0`; или * не передавайте параметр `item`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} **Возврат денег покупателю** Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней: * при оплате банковской картой — с момента, когда магазин переведет заказ в статус `SHIPPED`; * при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/items

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/items" \
 -d '{
  "reason" : "PARTNER_REQUESTED_REMOVE",
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderItemRequest updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

try {
    final result = await api_instance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderItems: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderItemRequest *updateOrderItemRequest = ; // 

// Удаление товара из заказа или уменьшение числа единиц
[apiInstance updateOrderItemsWith:campaignId
    orderId:orderId
    updateOrderItemRequest:updateOrderItemRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderItemRequest = ; // {UpdateOrderItemRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrderItems(campaignId, orderId, updateOrderItemRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderItemsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

            try {
                // Удаление товара из заказа или уменьшение числа единиц
                apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOrderItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderItemRequest = ; // UpdateOrderItemRequest | 

try {
    $api_instance->updateOrderItems($campaignId, $orderId, $updateOrderItemRequest);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderItemRequest = WWW::OPenAPIClient::Object::UpdateOrderItemRequest->new(); # UpdateOrderItemRequest | 

eval {
    $api_instance->updateOrderItems(campaignId => $campaignId, orderId => $orderId, updateOrderItemRequest => $updateOrderItemRequest);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOrderItems: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderItemRequest =  # UpdateOrderItemRequest | 

try:
    # Удаление товара из заказа или уменьшение числа единиц
    api_instance.update_order_items(campaignId, orderId, updateOrderItemRequest)
except ApiException as e:
    print("Exception when calling FbsApi->updateOrderItems: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderItemRequest = ; // UpdateOrderItemRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOrderItems(campaignId, orderId, updateOrderItemRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderItemRequest *

Responses


updateOrderStatus

Изменение статуса одного заказа

Изменяет статус заказа. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/status

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/status" \
 -d '{
  "order" : {
    "delivery" : {
      "dates" : {
        "realDeliveryDate" : "2000-01-23"
      }
    },
    "substatus" : "RESERVATION_EXPIRED",
    "status" : "PLACING"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStatusRequest updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

try {
    final result = await api_instance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatus: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStatusRequest *updateOrderStatusRequest = ; // 

// Изменение статуса одного заказа
[apiInstance updateOrderStatusWith:campaignId
    orderId:orderId
    updateOrderStatusRequest:updateOrderStatusRequest
              completionHandler: ^(UpdateOrderStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStatusRequest = ; // {UpdateOrderStatusRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

            try {
                // Изменение статуса одного заказа
                UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOrderStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

try {
    $result = $api_instance->updateOrderStatus($campaignId, $orderId, $updateOrderStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOrderStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStatusRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusRequest->new(); # UpdateOrderStatusRequest | 

eval {
    my $result = $api_instance->updateOrderStatus(campaignId => $campaignId, orderId => $orderId, updateOrderStatusRequest => $updateOrderStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOrderStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStatusRequest =  # UpdateOrderStatusRequest | 

try:
    # Изменение статуса одного заказа
    api_response = api_instance.update_order_status(campaignId, orderId, updateOrderStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateOrderStatus: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStatusRequest = ; // UpdateOrderStatusRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStatusRequest *

Responses


updateOrderStatuses

Изменение статусов нескольких заказов

Изменяет статусы нескольких заказов. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"`и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/status-update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/status-update" \
 -d '{
  "orders" : [ {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOrderStatusesRequest updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

try {
    final result = await api_instance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatuses: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOrderStatusesRequest *updateOrderStatusesRequest = ; // 

// Изменение статусов нескольких заказов
[apiInstance updateOrderStatusesWith:campaignId
    updateOrderStatusesRequest:updateOrderStatusesRequest
              completionHandler: ^(UpdateOrderStatusesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOrderStatusesRequest = ; // {UpdateOrderStatusesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatuses(campaignId, updateOrderStatusesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

            try {
                // Изменение статусов нескольких заказов
                UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateOrderStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

try {
    $result = $api_instance->updateOrderStatuses($campaignId, $updateOrderStatusesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateOrderStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOrderStatusesRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusesRequest->new(); # UpdateOrderStatusesRequest | 

eval {
    my $result = $api_instance->updateOrderStatuses(campaignId => $campaignId, updateOrderStatusesRequest => $updateOrderStatusesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateOrderStatuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOrderStatusesRequest =  # UpdateOrderStatusesRequest | 

try:
    # Изменение статусов нескольких заказов
    api_response = api_instance.update_order_statuses(campaignId, updateOrderStatusesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateOrderStatuses: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateOrderStatuses(campaignId, updateOrderStatusesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOrderStatusesRequest *

Responses


updatePrices

Установка цен на товары в конкретном магазине

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для управления базовыми ценами используйте [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updatePrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePricesRequest updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

try {
    final result = await api_instance.updatePrices(campaignId, updatePricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePrices: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updatePrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePricesRequest *updatePricesRequest = ; // 

// Установка цен на товары в конкретном магазине
[apiInstance updatePricesWith:campaignId
    updatePricesRequest:updatePricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePricesRequest = ; // {UpdatePricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePrices(campaignId, updatePricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

            try {
                // Установка цен на товары в конкретном магазине
                EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updatePrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePricesRequest = ; // UpdatePricesRequest | 

try {
    $result = $api_instance->updatePrices($campaignId, $updatePricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updatePrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePricesRequest = WWW::OPenAPIClient::Object::UpdatePricesRequest->new(); # UpdatePricesRequest | 

eval {
    my $result = $api_instance->updatePrices(campaignId => $campaignId, updatePricesRequest => $updatePricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updatePrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePricesRequest =  # UpdatePricesRequest | 

try:
    # Установка цен на товары в конкретном магазине
    api_response = api_instance.update_prices(campaignId, updatePricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updatePrices: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updatePricesRequest = ; // UpdatePricesRequest

    let mut context = FbsApi::Context::default();
    let result = client.updatePrices(campaignId, updatePricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePricesRequest *

Responses


updatePromoOffers

Добавление товаров в акцию или изменение их цен

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/update" \
 -d '{
  "offers" : [ {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  } ],
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePromoOffersRequest updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

try {
    final result = await api_instance.updatePromoOffers(businessId, updatePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePromoOffers: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePromoOffersRequest *updatePromoOffersRequest = ; // 

// Добавление товаров в акцию или изменение их цен
[apiInstance updatePromoOffersWith:businessId
    updatePromoOffersRequest:updatePromoOffersRequest
              completionHandler: ^(UpdatePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePromoOffersRequest = ; // {UpdatePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePromoOffers(businessId, updatePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

            try {
                // Добавление товаров в акцию или изменение их цен
                UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updatePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

try {
    $result = $api_instance->updatePromoOffers($businessId, $updatePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updatePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePromoOffersRequest = WWW::OPenAPIClient::Object::UpdatePromoOffersRequest->new(); # UpdatePromoOffersRequest | 

eval {
    my $result = $api_instance->updatePromoOffers(businessId => $businessId, updatePromoOffersRequest => $updatePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updatePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePromoOffersRequest =  # UpdatePromoOffersRequest | 

try:
    # Добавление товаров в акцию или изменение их цен
    api_response = api_instance.update_promo_offers(businessId, updatePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updatePromoOffers: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let businessId = 789; // Long
    let updatePromoOffersRequest = ; // UpdatePromoOffersRequest

    let mut context = FbsApi::Context::default();
    let result = client.updatePromoOffers(businessId, updatePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePromoOffersRequest *

Responses


updateStocks

Передача информации об остатках

Передает данные об остатках товаров на витрине. Обязательно указывайте SKU **в точности** так, как он указан в каталоге. Например, _557722_ и _0557722_ — это два разных SKU. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks" \
 -d '{
  "skus" : [ {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbsApi;

import java.io.File;
import java.util.*;

public class FbsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateStocksRequest updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

try {
    final result = await api_instance.updateStocks(campaignId, updateStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStocks: $e\n');
}

import org.openapitools.client.api.FbsApi;

public class FbsApiExample {
    public static void main(String[] args) {
        FbsApi apiInstance = new FbsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbsApi#updateStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbsApi *apiInstance = [[FbsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateStocksRequest *updateStocksRequest = ; // 

// Передача информации об остатках
[apiInstance updateStocksWith:campaignId
    updateStocksRequest:updateStocksRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateStocksRequest = ; // {UpdateStocksRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStocks(campaignId, updateStocksRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

            try {
                // Передача информации об остатках
                EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbsApi.updateStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateStocksRequest = ; // UpdateStocksRequest | 

try {
    $result = $api_instance->updateStocks($campaignId, $updateStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbsApi->updateStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateStocksRequest = WWW::OPenAPIClient::Object::UpdateStocksRequest->new(); # UpdateStocksRequest | 

eval {
    my $result = $api_instance->updateStocks(campaignId => $campaignId, updateStocksRequest => $updateStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbsApi->updateStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateStocksRequest =  # UpdateStocksRequest | 

try:
    # Передача информации об остатках
    api_response = api_instance.update_stocks(campaignId, updateStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbsApi->updateStocks: %s\n" % e)
extern crate FbsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateStocksRequest = ; // UpdateStocksRequest

    let mut context = FbsApi::Context::default();
    let result = client.updateStocks(campaignId, updateStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateStocksRequest *

Responses


Fby

addHiddenOffers

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddHiddenOffersRequest addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

try {
    final result = await api_instance.addHiddenOffers(campaignId, addHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddHiddenOffersRequest *addHiddenOffersRequest = ; // 

// Скрытие товаров и настройки скрытия
[apiInstance addHiddenOffersWith:campaignId
    addHiddenOffersRequest:addHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addHiddenOffersRequest = ; // {AddHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addHiddenOffers(campaignId, addHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

            try {
                // Скрытие товаров и настройки скрытия
                EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.addHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

try {
    $result = $api_instance->addHiddenOffers($campaignId, $addHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->addHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addHiddenOffersRequest = WWW::OPenAPIClient::Object::AddHiddenOffersRequest->new(); # AddHiddenOffersRequest | 

eval {
    my $result = $api_instance->addHiddenOffers(campaignId => $campaignId, addHiddenOffersRequest => $addHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->addHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addHiddenOffersRequest =  # AddHiddenOffersRequest | 

try:
    # Скрытие товаров и настройки скрытия
    api_response = api_instance.add_hidden_offers(campaignId, addHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->addHiddenOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let addHiddenOffersRequest = ; // AddHiddenOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.addHiddenOffers(campaignId, addHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addHiddenOffersRequest *

Запрос на скрытие оферов.

Responses


addOffersToArchive

Добавление товаров в архив

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета. {% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %} Вначале такой товар нужно распродать или вывезти. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/archive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/archive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddOffersToArchiveRequest addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

try {
    final result = await api_instance.addOffersToArchive(businessId, addOffersToArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOffersToArchive: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddOffersToArchiveRequest addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

        try {
            AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#addOffersToArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddOffersToArchiveRequest *addOffersToArchiveRequest = ; // 

// Добавление товаров в архив
[apiInstance addOffersToArchiveWith:businessId
    addOffersToArchiveRequest:addOffersToArchiveRequest
              completionHandler: ^(AddOffersToArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addOffersToArchiveRequest = ; // {AddOffersToArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOffersToArchive(businessId, addOffersToArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addOffersToArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addOffersToArchiveRequest = new AddOffersToArchiveRequest(); // AddOffersToArchiveRequest | 

            try {
                // Добавление товаров в архив
                AddOffersToArchiveResponse result = apiInstance.addOffersToArchive(businessId, addOffersToArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.addOffersToArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addOffersToArchiveRequest = ; // AddOffersToArchiveRequest | 

try {
    $result = $api_instance->addOffersToArchive($businessId, $addOffersToArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->addOffersToArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addOffersToArchiveRequest = WWW::OPenAPIClient::Object::AddOffersToArchiveRequest->new(); # AddOffersToArchiveRequest | 

eval {
    my $result = $api_instance->addOffersToArchive(businessId => $businessId, addOffersToArchiveRequest => $addOffersToArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->addOffersToArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addOffersToArchiveRequest =  # AddOffersToArchiveRequest | 

try:
    # Добавление товаров в архив
    api_response = api_instance.add_offers_to_archive(businessId, addOffersToArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->addOffersToArchive: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let addOffersToArchiveRequest = ; // AddOffersToArchiveRequest

    let mut context = FbyApi::Context::default();
    let result = client.addOffersToArchive(businessId, addOffersToArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addOffersToArchiveRequest *

Responses


calculateTariffs

Калькулятор стоимости услуг

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги. Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг. В запросе можно указать либо параметр `campaignId`, либо `sellingProgram`. Совместное использование параметров приведет к ошибке. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/tariffs/calculate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/tariffs/calculate" \
 -d '{
  "offers" : [ {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  } ],
  "parameters" : {
    "campaignId" : 0,
    "sellingProgram" : "FBY",
    "frequency" : "DAILY"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CalculateTariffsRequest calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

try {
    final result = await api_instance.calculateTariffs(calculateTariffsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->calculateTariffs: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
CalculateTariffsRequest *calculateTariffsRequest = ; // 

// Калькулятор стоимости услуг
[apiInstance calculateTariffsWith:calculateTariffsRequest
              completionHandler: ^(CalculateTariffsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var calculateTariffsRequest = ; // {CalculateTariffsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateTariffs(calculateTariffsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class calculateTariffsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

            try {
                // Калькулятор стоимости услуг
                CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.calculateTariffs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$calculateTariffsRequest = ; // CalculateTariffsRequest | 

try {
    $result = $api_instance->calculateTariffs($calculateTariffsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->calculateTariffs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $calculateTariffsRequest = WWW::OPenAPIClient::Object::CalculateTariffsRequest->new(); # CalculateTariffsRequest | 

eval {
    my $result = $api_instance->calculateTariffs(calculateTariffsRequest => $calculateTariffsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->calculateTariffs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
calculateTariffsRequest =  # CalculateTariffsRequest | 

try:
    # Калькулятор стоимости услуг
    api_response = api_instance.calculate_tariffs(calculateTariffsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->calculateTariffs: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let calculateTariffsRequest = ; // CalculateTariffsRequest

    let mut context = FbyApi::Context::default();
    let result = client.calculateTariffs(calculateTariffsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
calculateTariffsRequest *

Responses


confirmBusinessPrices

Удаление товара из карантина по цене в кабинете

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина. Основная цена задается в каталоге и действует во всех магазинах кабинета. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST businesses/{businessId}/price-quarantine](getBusinessQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmBusinessPrices(businessId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmBusinessPrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в кабинете
[apiInstance confirmBusinessPricesWith:businessId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmBusinessPrices(businessId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в кабинете
                EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.confirmBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmBusinessPrices($businessId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->confirmBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmBusinessPrices(businessId => $businessId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->confirmBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в кабинете
    api_response = api_instance.confirm_business_prices(businessId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->confirmBusinessPrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = FbyApi::Context::default();
    let result = client.confirmBusinessPrices(businessId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmCampaignPrices

Удаление товара из карантина по цене в магазине

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST campaigns/{campaignId}/price-quarantine](getCampaignQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmCampaignPrices(campaignId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmCampaignPrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в магазине
[apiInstance confirmCampaignPricesWith:campaignId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmCampaignPrices(campaignId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmCampaignPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в магазине
                EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.confirmCampaignPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmCampaignPrices($campaignId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->confirmCampaignPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmCampaignPrices(campaignId => $campaignId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->confirmCampaignPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в магазине
    api_response = api_instance.confirm_campaign_prices(campaignId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->confirmCampaignPrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = FbyApi::Context::default();
    let result = client.confirmCampaignPrices(campaignId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


createChat

Создание нового чата с покупателем

Создает новый чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/new

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/new" \
 -d '{
  "orderId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#createChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final CreateChatRequest createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

try {
    final result = await api_instance.createChat(businessId, createChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createChat: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        CreateChatRequest createChatRequest = ; // CreateChatRequest | 

        try {
            CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#createChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
CreateChatRequest *createChatRequest = ; // 

// Создание нового чата с покупателем
[apiInstance createChatWith:businessId
    createChatRequest:createChatRequest
              completionHandler: ^(CreateChatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var createChatRequest = ; // {CreateChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChat(businessId, createChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var createChatRequest = new CreateChatRequest(); // CreateChatRequest | 

            try {
                // Создание нового чата с покупателем
                CreateChatResponse result = apiInstance.createChat(businessId, createChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.createChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$createChatRequest = ; // CreateChatRequest | 

try {
    $result = $api_instance->createChat($businessId, $createChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->createChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $createChatRequest = WWW::OPenAPIClient::Object::CreateChatRequest->new(); # CreateChatRequest | 

eval {
    my $result = $api_instance->createChat(businessId => $businessId, createChatRequest => $createChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->createChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
createChatRequest =  # CreateChatRequest | 

try:
    # Создание нового чата с покупателем
    api_response = api_instance.create_chat(businessId, createChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->createChat: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let createChatRequest = ; // CreateChatRequest

    let mut context = FbyApi::Context::default();
    let result = client.createChat(businessId, createChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
createChatRequest *

description

Responses


deleteCampaignOffers

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteCampaignOffersRequest deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

try {
    final result = await api_instance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteCampaignOffersRequest *deleteCampaignOffersRequest = ; // 

// Удаление товаров из ассортимента магазина
[apiInstance deleteCampaignOffersWith:campaignId
    deleteCampaignOffersRequest:deleteCampaignOffersRequest
              completionHandler: ^(DeleteCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteCampaignOffersRequest = ; // {DeleteCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

            try {
                // Удаление товаров из ассортимента магазина
                DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deleteCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

try {
    $result = $api_instance->deleteCampaignOffers($campaignId, $deleteCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deleteCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteCampaignOffersRequest = WWW::OPenAPIClient::Object::DeleteCampaignOffersRequest->new(); # DeleteCampaignOffersRequest | 

eval {
    my $result = $api_instance->deleteCampaignOffers(campaignId => $campaignId, deleteCampaignOffersRequest => $deleteCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deleteCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteCampaignOffersRequest =  # DeleteCampaignOffersRequest | 

try:
    # Удаление товаров из ассортимента магазина
    api_response = api_instance.delete_campaign_offers(campaignId, deleteCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deleteCampaignOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteCampaignOffersRequest *

Responses


deleteGoodsFeedbackComment

Удаление комментария к отзыву

Удаляет комментарий магазина. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/delete" \
 -d '{
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteGoodsFeedbackCommentRequest *deleteGoodsFeedbackCommentRequest = ; // 

// Удаление комментария к отзыву
[apiInstance deleteGoodsFeedbackCommentWith:businessId
    deleteGoodsFeedbackCommentRequest:deleteGoodsFeedbackCommentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteGoodsFeedbackCommentRequest = ; // {DeleteGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

            try {
                // Удаление комментария к отзыву
                EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deleteGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->deleteGoodsFeedbackComment($businessId, $deleteGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deleteGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::DeleteGoodsFeedbackCommentRequest->new(); # DeleteGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->deleteGoodsFeedbackComment(businessId => $businessId, deleteGoodsFeedbackCommentRequest => $deleteGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deleteGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteGoodsFeedbackCommentRequest =  # DeleteGoodsFeedbackCommentRequest | 

try:
    # Удаление комментария к отзыву
    api_response = api_instance.delete_goods_feedback_comment(businessId, deleteGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deleteGoodsFeedbackComment: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest

    let mut context = FbyApi::Context::default();
    let result = client.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteGoodsFeedbackCommentRequest *

Responses


deleteHiddenOffers

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers/delete" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteHiddenOffersRequest deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

try {
    final result = await api_instance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteHiddenOffersRequest *deleteHiddenOffersRequest = ; // 

// Возобновление показа товаров
[apiInstance deleteHiddenOffersWith:campaignId
    deleteHiddenOffersRequest:deleteHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteHiddenOffersRequest = ; // {DeleteHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

            try {
                // Возобновление показа товаров
                EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deleteHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

try {
    $result = $api_instance->deleteHiddenOffers($campaignId, $deleteHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deleteHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteHiddenOffersRequest = WWW::OPenAPIClient::Object::DeleteHiddenOffersRequest->new(); # DeleteHiddenOffersRequest | 

eval {
    my $result = $api_instance->deleteHiddenOffers(campaignId => $campaignId, deleteHiddenOffersRequest => $deleteHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deleteHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteHiddenOffersRequest =  # DeleteHiddenOffersRequest | 

try:
    # Возобновление показа товаров
    api_response = api_instance.delete_hidden_offers(campaignId, deleteHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deleteHiddenOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteHiddenOffersRequest *

Запрос на возобновление показа оферов.

Responses


deleteOffers

Удаление товаров из каталога

Удаляет товары из каталога. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersRequest deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

try {
    final result = await api_instance.deleteOffers(businessId, deleteOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersRequest deleteOffersRequest = ; // DeleteOffersRequest | 

        try {
            DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersRequest *deleteOffersRequest = ; // 

// Удаление товаров из каталога
[apiInstance deleteOffersWith:businessId
    deleteOffersRequest:deleteOffersRequest
              completionHandler: ^(DeleteOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersRequest = ; // {DeleteOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffers(businessId, deleteOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersRequest = new DeleteOffersRequest(); // DeleteOffersRequest | 

            try {
                // Удаление товаров из каталога
                DeleteOffersResponse result = apiInstance.deleteOffers(businessId, deleteOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deleteOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersRequest = ; // DeleteOffersRequest | 

try {
    $result = $api_instance->deleteOffers($businessId, $deleteOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deleteOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersRequest = WWW::OPenAPIClient::Object::DeleteOffersRequest->new(); # DeleteOffersRequest | 

eval {
    my $result = $api_instance->deleteOffers(businessId => $businessId, deleteOffersRequest => $deleteOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deleteOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersRequest =  # DeleteOffersRequest | 

try:
    # Удаление товаров из каталога
    api_response = api_instance.delete_offers(businessId, deleteOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deleteOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersRequest = ; // DeleteOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.deleteOffers(businessId, deleteOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersRequest *

Responses


deleteOffersFromArchive

Удаление товаров из архива

Восстанавливает товары из архива. |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/unarchive

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/unarchive" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

try {
    final result = await api_instance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOffersFromArchive: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteOffersFromArchiveRequest deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

        try {
            DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deleteOffersFromArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteOffersFromArchiveRequest *deleteOffersFromArchiveRequest = ; // 

// Удаление товаров из архива
[apiInstance deleteOffersFromArchiveWith:businessId
    deleteOffersFromArchiveRequest:deleteOffersFromArchiveRequest
              completionHandler: ^(DeleteOffersFromArchiveResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteOffersFromArchiveRequest = ; // {DeleteOffersFromArchiveRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOffersFromArchiveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteOffersFromArchiveRequest = new DeleteOffersFromArchiveRequest(); // DeleteOffersFromArchiveRequest | 

            try {
                // Удаление товаров из архива
                DeleteOffersFromArchiveResponse result = apiInstance.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deleteOffersFromArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest | 

try {
    $result = $api_instance->deleteOffersFromArchive($businessId, $deleteOffersFromArchiveRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deleteOffersFromArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteOffersFromArchiveRequest = WWW::OPenAPIClient::Object::DeleteOffersFromArchiveRequest->new(); # DeleteOffersFromArchiveRequest | 

eval {
    my $result = $api_instance->deleteOffersFromArchive(businessId => $businessId, deleteOffersFromArchiveRequest => $deleteOffersFromArchiveRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deleteOffersFromArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteOffersFromArchiveRequest =  # DeleteOffersFromArchiveRequest | 

try:
    # Удаление товаров из архива
    api_response = api_instance.delete_offers_from_archive(businessId, deleteOffersFromArchiveRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deleteOffersFromArchive: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteOffersFromArchiveRequest = ; // DeleteOffersFromArchiveRequest

    let mut context = FbyApi::Context::default();
    let result = client.deleteOffersFromArchive(businessId, deleteOffersFromArchiveRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteOffersFromArchiveRequest *

Responses


deletePromoOffers

Удаление товаров из акции

Убирает товары из акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete" \
 -d '{
  "deleteAllOffers" : true,
  "promoId" : "promoId",
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeletePromoOffersRequest deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

try {
    final result = await api_instance.deletePromoOffers(businessId, deletePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePromoOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeletePromoOffersRequest *deletePromoOffersRequest = ; // 

// Удаление товаров из акции
[apiInstance deletePromoOffersWith:businessId
    deletePromoOffersRequest:deletePromoOffersRequest
              completionHandler: ^(DeletePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deletePromoOffersRequest = ; // {DeletePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePromoOffers(businessId, deletePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deletePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

            try {
                // Удаление товаров из акции
                DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.deletePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

try {
    $result = $api_instance->deletePromoOffers($businessId, $deletePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->deletePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deletePromoOffersRequest = WWW::OPenAPIClient::Object::DeletePromoOffersRequest->new(); # DeletePromoOffersRequest | 

eval {
    my $result = $api_instance->deletePromoOffers(businessId => $businessId, deletePromoOffersRequest => $deletePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->deletePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deletePromoOffersRequest =  # DeletePromoOffersRequest | 

try:
    # Удаление товаров из акции
    api_response = api_instance.delete_promo_offers(businessId, deletePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->deletePromoOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let deletePromoOffersRequest = ; // DeletePromoOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.deletePromoOffers(businessId, deletePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deletePromoOffersRequest *

Responses


generateBoostConsolidatedReport

Отчет по бусту продаж

Запускает генерацию **сводного отчета по бусту продаж** за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/boost-consolidated/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/boost-consolidated/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBoostConsolidatedReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateBoostConsolidatedRequest *generateBoostConsolidatedRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по бусту продаж
[apiInstance generateBoostConsolidatedReportWith:generateBoostConsolidatedRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateBoostConsolidatedRequest = ; // {GenerateBoostConsolidatedRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateBoostConsolidatedReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по бусту продаж
                GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateBoostConsolidatedReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateBoostConsolidatedReport($generateBoostConsolidatedRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateBoostConsolidatedReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateBoostConsolidatedRequest = WWW::OPenAPIClient::Object::GenerateBoostConsolidatedRequest->new(); # GenerateBoostConsolidatedRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateBoostConsolidatedReport(generateBoostConsolidatedRequest => $generateBoostConsolidatedRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateBoostConsolidatedReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateBoostConsolidatedRequest =  # GenerateBoostConsolidatedRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по бусту продаж
    api_response = api_instance.generate_boost_consolidated_report(generateBoostConsolidatedRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateBoostConsolidatedReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateBoostConsolidatedRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateCompetitorsPositionReport

Отчет «Конкурентная позиция»

Запускает генерацию **отчета «Конкурентная позиция»** за заданный период. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/analytics/competitors.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). {% note info "Значение -1 в отчете" %} Если в CSV-файле в столбце **POSITION** стоит -1, в этот день не было заказов с товарами в указанной категории. {% endnote %} |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/competitors-position/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/competitors-position/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "categoryId" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateCompetitorsPositionReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateCompetitorsPositionReportRequest *generateCompetitorsPositionReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Конкурентная позиция»
[apiInstance generateCompetitorsPositionReportWith:generateCompetitorsPositionReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateCompetitorsPositionReportRequest = ; // {GenerateCompetitorsPositionReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateCompetitorsPositionReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Конкурентная позиция»
                GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateCompetitorsPositionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateCompetitorsPositionReport($generateCompetitorsPositionReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateCompetitorsPositionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateCompetitorsPositionReportRequest = WWW::OPenAPIClient::Object::GenerateCompetitorsPositionReportRequest->new(); # GenerateCompetitorsPositionReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest => $generateCompetitorsPositionReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateCompetitorsPositionReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateCompetitorsPositionReportRequest =  # GenerateCompetitorsPositionReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Конкурентная позиция»
    api_response = api_instance.generate_competitors_position_report(generateCompetitorsPositionReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateCompetitorsPositionReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateCompetitorsPositionReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsFeedbackReport

Отчет по отзывам о товарах

Запускает генерацию **отчета по отзывам о товарах**. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/marketing/plus-reviews#stat) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-feedback/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-feedback/generate?format=" \
 -d '{
  "businessId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsFeedbackReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateGoodsFeedbackRequest *generateGoodsFeedbackRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по отзывам о товарах
[apiInstance generateGoodsFeedbackReportWith:generateGoodsFeedbackRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateGoodsFeedbackRequest = ; // {GenerateGoodsFeedbackRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsFeedbackReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по отзывам о товарах
                GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateGoodsFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsFeedbackReport($generateGoodsFeedbackRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateGoodsFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GenerateGoodsFeedbackRequest->new(); # GenerateGoodsFeedbackRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsFeedbackReport(generateGoodsFeedbackRequest => $generateGoodsFeedbackRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateGoodsFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateGoodsFeedbackRequest =  # GenerateGoodsFeedbackRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по отзывам о товарах
    api_response = api_instance.generate_goods_feedback_report(generateGoodsFeedbackRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateGoodsFeedbackReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsFeedbackRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsMovementReport

Отчет по движению товаров

Запускает генерацию **отчета по движению товаров**. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#flow) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-movement/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-movement/generate?format=" \
 -d '{
  "shopSku" : "shopSku",
  "campaignId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsMovementReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = new GenerateGoodsMovementReportRequest(); // GenerateGoodsMovementReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsMovementReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsMovementReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateGoodsMovementReportRequest *generateGoodsMovementReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по движению товаров
[apiInstance generateGoodsMovementReportWith:generateGoodsMovementReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateGoodsMovementReportRequest = ; // {GenerateGoodsMovementReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsMovementReport(generateGoodsMovementReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsMovementReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateGoodsMovementReportRequest = new GenerateGoodsMovementReportRequest(); // GenerateGoodsMovementReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по движению товаров
                GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateGoodsMovementReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsMovementReport($generateGoodsMovementReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateGoodsMovementReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateGoodsMovementReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsMovementReportRequest->new(); # GenerateGoodsMovementReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsMovementReport(generateGoodsMovementReportRequest => $generateGoodsMovementReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateGoodsMovementReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateGoodsMovementReportRequest =  # GenerateGoodsMovementReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по движению товаров
    api_response = api_instance.generate_goods_movement_report(generateGoodsMovementReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateGoodsMovementReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateGoodsMovementReport(generateGoodsMovementReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsMovementReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsRealizationReport

Отчет по реализации

Запускает генерацию **отчета по реализации** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#sales-report) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-realization/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-realization/generate?format=" \
 -d '{
  "month" : 2,
  "year" : 6,
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsRealizationReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateGoodsRealizationReportRequest *generateGoodsRealizationReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по реализации
[apiInstance generateGoodsRealizationReportWith:generateGoodsRealizationReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateGoodsRealizationReportRequest = ; // {GenerateGoodsRealizationReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsRealizationReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по реализации
                GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateGoodsRealizationReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsRealizationReport($generateGoodsRealizationReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateGoodsRealizationReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateGoodsRealizationReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsRealizationReportRequest->new(); # GenerateGoodsRealizationReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsRealizationReport(generateGoodsRealizationReportRequest => $generateGoodsRealizationReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateGoodsRealizationReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateGoodsRealizationReportRequest =  # GenerateGoodsRealizationReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по реализации
    api_response = api_instance.generate_goods_realization_report(generateGoodsRealizationReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateGoodsRealizationReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsRealizationReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsTurnoverReport

Отчет по оборачиваемости

Запускает генерацию **отчета по оборачиваемости** за заданную дату. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/turnover.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-turnover/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-turnover/generate?format=" \
 -d '{
  "date" : "2000-01-23",
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsTurnoverReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = new GenerateGoodsTurnoverRequest(); // GenerateGoodsTurnoverRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsTurnoverReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateGoodsTurnoverReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateGoodsTurnoverRequest *generateGoodsTurnoverRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по оборачиваемости
[apiInstance generateGoodsTurnoverReportWith:generateGoodsTurnoverRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateGoodsTurnoverRequest = ; // {GenerateGoodsTurnoverRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsTurnoverReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateGoodsTurnoverRequest = new GenerateGoodsTurnoverRequest(); // GenerateGoodsTurnoverRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по оборачиваемости
                GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateGoodsTurnoverReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsTurnoverReport($generateGoodsTurnoverRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateGoodsTurnoverReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateGoodsTurnoverRequest = WWW::OPenAPIClient::Object::GenerateGoodsTurnoverRequest->new(); # GenerateGoodsTurnoverRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsTurnoverReport(generateGoodsTurnoverRequest => $generateGoodsTurnoverRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateGoodsTurnoverReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateGoodsTurnoverRequest =  # GenerateGoodsTurnoverRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по оборачиваемости
    api_response = api_instance.generate_goods_turnover_report(generateGoodsTurnoverRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateGoodsTurnoverReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsTurnoverRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generatePricesReport

Отчет «Цены на рынке»

Запускает генерацию **отчета «Цены на рынке»**. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/prices/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/prices/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "creationDateTo" : "2000-01-23",
  "campaignId" : 6,
  "businessId" : 0,
  "creationDateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GeneratePricesReportRequest generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generatePricesReport(generatePricesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generatePricesReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GeneratePricesReportRequest *generatePricesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Цены на рынке»
[apiInstance generatePricesReportWith:generatePricesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generatePricesReportRequest = ; // {GeneratePricesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generatePricesReport(generatePricesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generatePricesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Цены на рынке»
                GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generatePricesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generatePricesReportRequest = ; // GeneratePricesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generatePricesReport($generatePricesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generatePricesReportRequest = WWW::OPenAPIClient::Object::GeneratePricesReportRequest->new(); # GeneratePricesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generatePricesReport(generatePricesReportRequest => $generatePricesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generatePricesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generatePricesReportRequest =  # GeneratePricesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Цены на рынке»
    api_response = api_instance.generate_prices_report(generatePricesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generatePricesReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generatePricesReportRequest = ; // GeneratePricesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generatePricesReport(generatePricesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generatePricesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShelfsStatisticsReport

Отчет по полкам

Запускает генерацию **сводного отчета по полкам** — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf). Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/shelf-statistics/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shelf-statistics/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "attributionType" : "CLICKS"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShelfsStatisticsReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateShelfsStatisticsRequest *generateShelfsStatisticsRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по полкам
[apiInstance generateShelfsStatisticsReportWith:generateShelfsStatisticsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateShelfsStatisticsRequest = ; // {GenerateShelfsStatisticsRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShelfsStatisticsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по полкам
                GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateShelfsStatisticsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShelfsStatisticsReport($generateShelfsStatisticsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateShelfsStatisticsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateShelfsStatisticsRequest = WWW::OPenAPIClient::Object::GenerateShelfsStatisticsRequest->new(); # GenerateShelfsStatisticsRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShelfsStatisticsReport(generateShelfsStatisticsRequest => $generateShelfsStatisticsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateShelfsStatisticsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateShelfsStatisticsRequest =  # GenerateShelfsStatisticsRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по полкам
    api_response = api_instance.generate_shelfs_statistics_report(generateShelfsStatisticsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateShelfsStatisticsReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShelfsStatisticsRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShowsSalesReport

Отчет «Аналитика продаж»

Запускает генерацию **отчета «Аналитика продаж»** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/shows-sales.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/shows-sales/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=" \
 -d '{
  "campaignId" : 6,
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "grouping" : "CATEGORIES"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShowsSalesReportRequest generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShowsSalesReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateShowsSalesReportRequest *generateShowsSalesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Аналитика продаж»
[apiInstance generateShowsSalesReportWith:generateShowsSalesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateShowsSalesReportRequest = ; // {GenerateShowsSalesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShowsSalesReport(generateShowsSalesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShowsSalesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Аналитика продаж»
                GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateShowsSalesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShowsSalesReport($generateShowsSalesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateShowsSalesReportRequest = WWW::OPenAPIClient::Object::GenerateShowsSalesReportRequest->new(); # GenerateShowsSalesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShowsSalesReport(generateShowsSalesReportRequest => $generateShowsSalesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateShowsSalesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateShowsSalesReportRequest =  # GenerateShowsSalesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Аналитика продаж»
    api_response = api_instance.generate_shows_sales_report(generateShowsSalesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateShowsSalesReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateShowsSalesReport(generateShowsSalesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShowsSalesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateStocksOnWarehousesReport

Отчет по остаткам на складах

Запускает генерацию **отчета по остаткам на складах**. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. * Для остальных моделей — об остатках на соответствующем складе магазина. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/stocks-on-warehouses/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "hasStocks" : true,
  "reportDate" : "2000-01-23",
  "campaignId" : 0,
  "warehouseIds" : [ 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateStocksOnWarehousesReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateStocksOnWarehousesReportRequest *generateStocksOnWarehousesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по остаткам на складах
[apiInstance generateStocksOnWarehousesReportWith:generateStocksOnWarehousesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateStocksOnWarehousesReportRequest = ; // {GenerateStocksOnWarehousesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateStocksOnWarehousesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по остаткам на складах
                GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateStocksOnWarehousesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateStocksOnWarehousesReport($generateStocksOnWarehousesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateStocksOnWarehousesReportRequest = WWW::OPenAPIClient::Object::GenerateStocksOnWarehousesReportRequest->new(); # GenerateStocksOnWarehousesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest => $generateStocksOnWarehousesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateStocksOnWarehousesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateStocksOnWarehousesReportRequest =  # GenerateStocksOnWarehousesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по остаткам на складах
    api_response = api_instance.generate_stocks_on_warehouses_report(generateStocksOnWarehousesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateStocksOnWarehousesReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateStocksOnWarehousesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedMarketplaceServicesReport

Отчет по стоимости услуг

Запускает генерацию **отчета по стоимости услуг** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports.html) Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-----------------------------|---------------------------------| |По дате начисления услуги |`dateFrom` и `dateTo` | |По дате формирования акта |`year` и `month` | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-marketplace-services/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-marketplace-services/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "yearFrom" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "monthFrom" : 2,
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 2, 2 ],
  "dateFrom" : "2000-01-23",
  "monthTo" : 7,
  "yearTo" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedMarketplaceServicesReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateUnitedMarketplaceServicesReportRequest *generateUnitedMarketplaceServicesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по стоимости услуг
[apiInstance generateUnitedMarketplaceServicesReportWith:generateUnitedMarketplaceServicesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateUnitedMarketplaceServicesReportRequest = ; // {GenerateUnitedMarketplaceServicesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedMarketplaceServicesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по стоимости услуг
                GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateUnitedMarketplaceServicesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedMarketplaceServicesReport($generateUnitedMarketplaceServicesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateUnitedMarketplaceServicesReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedMarketplaceServicesReportRequest->new(); # GenerateUnitedMarketplaceServicesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest => $generateUnitedMarketplaceServicesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateUnitedMarketplaceServicesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateUnitedMarketplaceServicesReportRequest =  # GenerateUnitedMarketplaceServicesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по стоимости услуг
    api_response = api_instance.generate_united_marketplace_services_report(generateUnitedMarketplaceServicesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateUnitedMarketplaceServicesReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedMarketplaceServicesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedNettingReport

Отчет по платежам

Запускает генерацию **отчета по платежам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/transactions.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-------------------------|---------------------------------------| |О платежах за период |`dateFrom` и `dateTo` | |О платежном поручении |`bankOrderId` и `bankOrderDateTime` | Заказать отчеты обоих типов одним запросом нельзя. |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-netting/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-netting/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "bankOrderId" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 1, 1 ],
  "dateFrom" : "2000-01-23",
  "bankOrderDateTime" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedNettingReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateUnitedNettingReportRequest *generateUnitedNettingReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по платежам
[apiInstance generateUnitedNettingReportWith:generateUnitedNettingReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateUnitedNettingReportRequest = ; // {GenerateUnitedNettingReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedNettingReport(generateUnitedNettingReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedNettingReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по платежам
                GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateUnitedNettingReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedNettingReport($generateUnitedNettingReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateUnitedNettingReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedNettingReportRequest->new(); # GenerateUnitedNettingReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedNettingReport(generateUnitedNettingReportRequest => $generateUnitedNettingReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateUnitedNettingReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateUnitedNettingReportRequest =  # GenerateUnitedNettingReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по платежам
    api_response = api_instance.generate_united_netting_report(generateUnitedNettingReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateUnitedNettingReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateUnitedNettingReport(generateUnitedNettingReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedNettingReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedOrdersReport

Отчет по заказам

Запускает генерацию **отчета по заказам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/orders.html) {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. [Как получить детальную информацию по заказам](../../reference/stats/getOrdersStats.md) {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-orders/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-orders/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 6, 6 ],
  "promoId" : "promoId",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedOrdersRequest generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedOrdersReport: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GenerateUnitedOrdersRequest *generateUnitedOrdersRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по заказам
[apiInstance generateUnitedOrdersReportWith:generateUnitedOrdersRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var generateUnitedOrdersRequest = ; // {GenerateUnitedOrdersRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedOrdersReport(generateUnitedOrdersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedOrdersReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по заказам
                GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.generateUnitedOrdersReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedOrdersReport($generateUnitedOrdersRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $generateUnitedOrdersRequest = WWW::OPenAPIClient::Object::GenerateUnitedOrdersRequest->new(); # GenerateUnitedOrdersRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedOrdersReport(generateUnitedOrdersRequest => $generateUnitedOrdersRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->generateUnitedOrdersReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
generateUnitedOrdersRequest =  # GenerateUnitedOrdersRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по заказам
    api_response = api_instance.generate_united_orders_report(generateUnitedOrdersRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->generateUnitedOrdersReport: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest
    let format = ; // ReportFormatType

    let mut context = FbyApi::Context::default();
    let result = client.generateUnitedOrdersReport(generateUnitedOrdersRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedOrdersRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


getAllOffers

Все предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers/all

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/all?feedId=789&chunk=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer chunk = new Integer(); // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    final result = await api_instance.getAllOffers(campaignId, feedId, chunk);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
Integer *chunk = 56; // Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

// Все предложения магазина
[apiInstance getAllOffersWith:campaignId
    feedId:feedId
    chunk:chunk
              completionHandler: ^(GetAllOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'chunk': 56 // {Integer} Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getAllOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var chunk = 56;  // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional)  (default to null)

            try {
                // Все предложения магазина
                GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getAllOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    $result = $api_instance->getAllOffers($campaignId, $feedId, $chunk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getAllOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $chunk = 56; # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


eval {
    my $result = $api_instance->getAllOffers(campaignId => $campaignId, feedId => $feedId, chunk => $chunk);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getAllOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
chunk = 56 # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

try:
    # Все предложения магазина
    api_response = api_instance.get_all_offers(campaignId, feedId=feedId, chunk=chunk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getAllOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let chunk = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getAllOffers(campaignId, feedId, chunk, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
feedId
Long (int64)
Идентификатор прайс-листа.
chunk
Integer (int32)
Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}

Responses


getBidsInfoForBusiness

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/info

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | 

try {
    final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest | 

        try {
            GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBidsInfoForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; //  (optional)

// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
    pageToken:pageToken
    limit:limit
    getBidsInfoRequest:getBidsInfoRequest
              completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getBidsInfoRequest':  // {GetBidsInfoRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsInfoForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |  (optional) 

            try {
                // Информация об установленных ставках
                GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getBidsInfoForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getBidsInfoRequest = ; // GetBidsInfoRequest | 

try {
    $result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest | 

eval {
    my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getBidsInfoRequest =  # GetBidsInfoRequest |  (optional)

try:
    # Информация об установленных ставках
    api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getBidsInfoForBusiness: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getBidsInfoRequest = ; // GetBidsInfoRequest

    let mut context = FbyApi::Context::default();
    let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsInfoRequest

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBidsRecommendations

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations" \
 -d '{
  "skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetBidsRecommendationsRequest getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

try {
    final result = await api_instance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBidsRecommendations: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetBidsRecommendationsRequest getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

        try {
            GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBidsRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetBidsRecommendationsRequest *getBidsRecommendationsRequest = ; // 

// Рекомендованные ставки для заданных товаров
[apiInstance getBidsRecommendationsWith:businessId
    getBidsRecommendationsRequest:getBidsRecommendationsRequest
              completionHandler: ^(GetBidsRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getBidsRecommendationsRequest = ; // {GetBidsRecommendationsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidsRecommendations(businessId, getBidsRecommendationsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBidsRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getBidsRecommendationsRequest = new GetBidsRecommendationsRequest(); // GetBidsRecommendationsRequest | 

            try {
                // Рекомендованные ставки для заданных товаров
                GetBidsRecommendationsResponse result = apiInstance.getBidsRecommendations(businessId, getBidsRecommendationsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getBidsRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest | 

try {
    $result = $api_instance->getBidsRecommendations($businessId, $getBidsRecommendationsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getBidsRecommendationsRequest = WWW::OPenAPIClient::Object::GetBidsRecommendationsRequest->new(); # GetBidsRecommendationsRequest | 

eval {
    my $result = $api_instance->getBidsRecommendations(businessId => $businessId, getBidsRecommendationsRequest => $getBidsRecommendationsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getBidsRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getBidsRecommendationsRequest =  # GetBidsRecommendationsRequest | 

try:
    # Рекомендованные ставки для заданных товаров
    api_response = api_instance.get_bids_recommendations(businessId, getBidsRecommendationsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getBidsRecommendations: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getBidsRecommendationsRequest = ; // GetBidsRecommendationsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getBidsRecommendations(businessId, getBidsRecommendationsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getBidsRecommendationsRequest *

description.

Responses


getBusinessQuarantineOffers

Список товаров, находящихся в карантине по цене в кабинете

Возвращает список товаров, которые находятся в карантине по **основной цене**. Основная цена задается в каталоге и действует во всех магазинах кабинета. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST businesses/{businessId}/price-quarantine/confirm](../../reference/business-assortment/confirmBusinessPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessQuarantineOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в кабинете
[apiInstance getBusinessQuarantineOffersWith:businessId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в кабинете
                GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getBusinessQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getBusinessQuarantineOffers($businessId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getBusinessQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getBusinessQuarantineOffers(businessId => $businessId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getBusinessQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в кабинете
    api_response = api_instance.get_business_quarantine_offers(businessId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getBusinessQuarantineOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getBusinessSettings

Настройки кабинета

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/settings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getBusinessSettings(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessSettings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getBusinessSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки кабинета
[apiInstance getBusinessSettingsWith:businessId
              completionHandler: ^(GetBusinessSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessSettings(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки кабинета
                GetBusinessSettingsResponse result = apiInstance.getBusinessSettings(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getBusinessSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getBusinessSettings($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getBusinessSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getBusinessSettings(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getBusinessSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки кабинета
    api_response = api_instance.get_business_settings(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getBusinessSettings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getBusinessSettings(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaign

Информация о магазине

Возвращает информацию о магазине. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaign(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaign: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignResponse result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Информация о магазине
[apiInstance getCampaignWith:campaignId
              completionHandler: ^(GetCampaignResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Информация о магазине
                GetCampaignResponse result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Информация о магазине
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaign: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignLogins

Логины, связанные с магазином

Возвращает список логинов, у которых есть доступ к магазину. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/logins

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/logins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignLogins(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignLogins: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignLogins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Логины, связанные с магазином
[apiInstance getCampaignLoginsWith:campaignId
              completionHandler: ^(GetCampaignLoginsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignLogins(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignLoginsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Логины, связанные с магазином
                GetCampaignLoginsResponse result = apiInstance.getCampaignLogins(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignLogins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignLogins($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignLogins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignLogins(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignLogins: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Логины, связанные с магазином
    api_response = api_instance.get_campaign_logins(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignLogins: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignLogins(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignOffers

Информация о товарах, которые размещены в заданном магазине

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "statuses" : [ "PUBLISHED", "PUBLISHED" ],
  "offerIds" : [ null, null, null, null, null ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetCampaignOffersRequest getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetCampaignOffersRequest *getCampaignOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Информация о товарах, которые размещены в заданном магазине
[apiInstance getCampaignOffersWith:campaignId
    getCampaignOffersRequest:getCampaignOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getCampaignOffersRequest = ; // {GetCampaignOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignOffers(campaignId, getCampaignOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Информация о товарах, которые размещены в заданном магазине
                GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignOffers($campaignId, $getCampaignOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getCampaignOffersRequest = WWW::OPenAPIClient::Object::GetCampaignOffersRequest->new(); # GetCampaignOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignOffers(campaignId => $campaignId, getCampaignOffersRequest => $getCampaignOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getCampaignOffersRequest =  # GetCampaignOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Информация о товарах, которые размещены в заданном магазине
    api_response = api_instance.get_campaign_offers(campaignId, getCampaignOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let getCampaignOffersRequest = ; // GetCampaignOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getCampaignOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignQuarantineOffers

Список товаров, находящихся в карантине по цене в магазине

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST campaigns/{campaignId}/price-quarantine/confirm](../../reference/assortment/confirmCampaignPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignQuarantineOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в магазине
[apiInstance getCampaignQuarantineOffersWith:campaignId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в магазине
                GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignQuarantineOffers($campaignId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignQuarantineOffers(campaignId => $campaignId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в магазине
    api_response = api_instance.get_campaign_quarantine_offers(campaignId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignQuarantineOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignRegion

Регион магазина

{% note warning "" %} Этот метод устарел. Вместо него используйте [GET campaigns/{campaignId}/settings](../../reference/campaigns/getCampaignSettings.md). {% endnote %} Возвращает регион, в котором находится магазин. |**⚙️ Лимит:** 5 000 запросов в час| |-|


/campaigns/{campaignId}/region

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignRegion(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignRegion: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Регион магазина
[apiInstance getCampaignRegionWith:campaignId
              completionHandler: ^(GetCampaignRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignRegion(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignRegionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Регион магазина
                GetCampaignRegionResponse result = apiInstance.getCampaignRegion(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignRegion($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignRegion(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Регион магазина
    api_response = api_instance.get_campaign_region(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignRegion: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignRegion(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaignSettings

Настройки магазина

Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/settings

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getCampaignSettings(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignSettings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Настройки магазина
[apiInstance getCampaignSettingsWith:campaignId
              completionHandler: ^(GetCampaignSettingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignSettings(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Настройки магазина
                GetCampaignSettingsResponse result = apiInstance.getCampaignSettings(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getCampaignSettings($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getCampaignSettings(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Настройки магазина
    api_response = api_instance.get_campaign_settings(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignSettings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignSettings(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getCampaigns

Список магазинов пользователя

Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaigns(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaigns: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Список магазинов пользователя
[apiInstance getCampaignsWith:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaigns(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Список магазинов пользователя
                GetCampaignsResponse result = apiInstance.getCampaigns(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaigns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaigns($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaigns(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Список магазинов пользователя
    api_response = api_instance.get_campaigns(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaigns: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getCampaigns(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCampaignsByLogin

Магазины, доступные логину

Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/by_login/{login}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/by_login/{login}?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String login = new String(); // String | Логин пользователя.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getCampaignsByLogin(login, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignsByLogin: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        String login = login_example; // String | Логин пользователя.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCampaignsByLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
String *login = login_example; // Логин пользователя. (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Магазины, доступные логину
[apiInstance getCampaignsByLoginWith:login
    page:page
    pageSize:pageSize
              completionHandler: ^(GetCampaignsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var login = login_example; // {String} Логин пользователя.
var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignsByLogin(login, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignsByLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var login = login_example;  // String | Логин пользователя. (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Магазины, доступные логину
                GetCampaignsResponse result = apiInstance.getCampaignsByLogin(login, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCampaignsByLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$login = login_example; // String | Логин пользователя.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getCampaignsByLogin($login, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCampaignsByLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $login = login_example; # String | Логин пользователя.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getCampaignsByLogin(login => $login, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCampaignsByLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
login = login_example # String | Логин пользователя. (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Магазины, доступные логину
    api_response = api_instance.get_campaigns_by_login(login, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCampaignsByLogin: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let login = login_example; // String
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getCampaignsByLogin(login, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
login*
String
Логин пользователя.
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getCategoriesMaxSaleQuantum

Лимит на установку кванта продажи и минимального количества товаров в заказе

Возвращает лимит на установку [кванта](*quantum) и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий. Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины. Подробнее о том, как продавать товары по несколько штук, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/fields/quantum). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/max-sale-quantum

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/max-sale-quantum" \
 -d '{
  "marketCategoryIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

try {
    final result = await api_instance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesMaxSaleQuantum: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GetCategoriesMaxSaleQuantumRequest getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

        try {
            GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoriesMaxSaleQuantum");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GetCategoriesMaxSaleQuantumRequest *getCategoriesMaxSaleQuantumRequest = ; // 

// Лимит на установку кванта продажи и минимального количества товаров в заказе
[apiInstance getCategoriesMaxSaleQuantumWith:getCategoriesMaxSaleQuantumRequest
              completionHandler: ^(GetCategoriesMaxSaleQuantumResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var getCategoriesMaxSaleQuantumRequest = ; // {GetCategoriesMaxSaleQuantumRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesMaxSaleQuantumExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var getCategoriesMaxSaleQuantumRequest = new GetCategoriesMaxSaleQuantumRequest(); // GetCategoriesMaxSaleQuantumRequest | 

            try {
                // Лимит на установку кванта продажи и минимального количества товаров в заказе
                GetCategoriesMaxSaleQuantumResponse result = apiInstance.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCategoriesMaxSaleQuantum: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest | 

try {
    $result = $api_instance->getCategoriesMaxSaleQuantum($getCategoriesMaxSaleQuantumRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCategoriesMaxSaleQuantum: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $getCategoriesMaxSaleQuantumRequest = WWW::OPenAPIClient::Object::GetCategoriesMaxSaleQuantumRequest->new(); # GetCategoriesMaxSaleQuantumRequest | 

eval {
    my $result = $api_instance->getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest => $getCategoriesMaxSaleQuantumRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCategoriesMaxSaleQuantum: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
getCategoriesMaxSaleQuantumRequest =  # GetCategoriesMaxSaleQuantumRequest | 

try:
    # Лимит на установку кванта продажи и минимального количества товаров в заказе
    api_response = api_instance.get_categories_max_sale_quantum(getCategoriesMaxSaleQuantumRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCategoriesMaxSaleQuantum: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let getCategoriesMaxSaleQuantumRequest = ; // GetCategoriesMaxSaleQuantumRequest

    let mut context = FbyApi::Context::default();
    let result = client.getCategoriesMaxSaleQuantum(getCategoriesMaxSaleQuantumRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesMaxSaleQuantumRequest *

Responses


getCategoriesTree

Дерево категорий

Возвращает дерево категорий Маркета. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/categories/tree

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/categories/tree" \
 -d '{
  "language" : "RU"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GetCategoriesRequest getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest | 

try {
    final result = await api_instance.getCategoriesTree(getCategoriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoriesTree: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        GetCategoriesRequest getCategoriesRequest = ; // GetCategoriesRequest | 

        try {
            GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoriesTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
GetCategoriesRequest *getCategoriesRequest = ; //  (optional)

// Дерево категорий
[apiInstance getCategoriesTreeWith:getCategoriesRequest
              completionHandler: ^(GetCategoriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var opts = {
  'getCategoriesRequest':  // {GetCategoriesRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoriesTree(opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoriesTreeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var getCategoriesRequest = new GetCategoriesRequest(); // GetCategoriesRequest |  (optional) 

            try {
                // Дерево категорий
                GetCategoriesResponse result = apiInstance.getCategoriesTree(getCategoriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCategoriesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$getCategoriesRequest = ; // GetCategoriesRequest | 

try {
    $result = $api_instance->getCategoriesTree($getCategoriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCategoriesTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $getCategoriesRequest = WWW::OPenAPIClient::Object::GetCategoriesRequest->new(); # GetCategoriesRequest | 

eval {
    my $result = $api_instance->getCategoriesTree(getCategoriesRequest => $getCategoriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCategoriesTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
getCategoriesRequest =  # GetCategoriesRequest |  (optional)

try:
    # Дерево категорий
    api_response = api_instance.get_categories_tree(getCategoriesRequest=getCategoriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCategoriesTree: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let getCategoriesRequest = ; // GetCategoriesRequest

    let mut context = FbyApi::Context::default();
    let result = client.getCategoriesTree(getCategoriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getCategoriesRequest

Responses


getCategoryContentParameters

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |**⚙️ Лимит:** 50 категорий в минуту | |-|


/category/{categoryId}/parameters

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/category/{categoryId}/parameters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long categoryId = new Long(); // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    final result = await api_instance.getCategoryContentParameters(categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryContentParameters: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


        try {
            GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getCategoryContentParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *categoryId = 789; // Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

// Списки характеристик товаров по категориям
[apiInstance getCategoryContentParametersWith:categoryId
              completionHandler: ^(GetCategoryContentParametersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var categoryId = 789; // {Long} Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryContentParameters(categoryId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCategoryContentParametersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var categoryId = 789;  // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

            try {
                // Списки характеристик товаров по категориям
                GetCategoryContentParametersResponse result = apiInstance.getCategoryContentParameters(categoryId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getCategoryContentParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$categoryId = 789; // Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


try {
    $result = $api_instance->getCategoryContentParameters($categoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getCategoryContentParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $categoryId = 789; # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).


eval {
    my $result = $api_instance->getCategoryContentParameters(categoryId => $categoryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getCategoryContentParameters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
categoryId = 789 # Long | Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
 (default to null)

try:
    # Списки характеристик товаров по категориям
    api_response = api_instance.get_category_content_parameters(categoryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getCategoryContentParameters: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let categoryId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getCategoryContentParameters(categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
categoryId*
Long (int64)
Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).
Required

Responses


getChatHistory

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats/history

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history?chatId=789&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "messageIdFrom" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final GetChatHistoryRequest getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChatHistory: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        GetChatHistoryRequest getChatHistoryRequest = ; // GetChatHistoryRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getChatHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
GetChatHistoryRequest *getChatHistoryRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение истории сообщений в чате
[apiInstance getChatHistoryWith:businessId
    chatId:chatId
    getChatHistoryRequest:getChatHistoryRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatHistoryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var getChatHistoryRequest = ; // {GetChatHistoryRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatHistory(businessId, chatId, getChatHistoryRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatHistoryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var getChatHistoryRequest = new GetChatHistoryRequest(); // GetChatHistoryRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение истории сообщений в чате
                GetChatHistoryResponse result = apiInstance.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getChatHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$getChatHistoryRequest = ; // GetChatHistoryRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChatHistory($businessId, $chatId, $getChatHistoryRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $getChatHistoryRequest = WWW::OPenAPIClient::Object::GetChatHistoryRequest->new(); # GetChatHistoryRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChatHistory(businessId => $businessId, chatId => $chatId, getChatHistoryRequest => $getChatHistoryRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getChatHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
getChatHistoryRequest =  # GetChatHistoryRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение истории сообщений в чате
    api_response = api_instance.get_chat_history(businessId, chatId, getChatHistoryRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getChatHistory: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let getChatHistoryRequest = ; // GetChatHistoryRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getChatHistory(businessId, chatId, getChatHistoryRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatHistoryRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getChats

Получение доступных чатов

Возвращает ваши чаты с покупателями. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/chats

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "types" : [ "CHAT", "CHAT" ],
  "statuses" : [ "NEW", "NEW" ],
  "orderIds" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getChats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetChatsRequest getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getChats(businessId, getChatsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getChats: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetChatsRequest getChatsRequest = ; // GetChatsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getChats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetChatsRequest *getChatsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение доступных чатов
[apiInstance getChatsWith:businessId
    getChatsRequest:getChatsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetChatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getChatsRequest = ; // {GetChatsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChats(businessId, getChatsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getChatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getChatsRequest = new GetChatsRequest(); // GetChatsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение доступных чатов
                GetChatsResponse result = apiInstance.getChats(businessId, getChatsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getChatsRequest = ; // GetChatsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getChats($businessId, $getChatsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getChatsRequest = WWW::OPenAPIClient::Object::GetChatsRequest->new(); # GetChatsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getChats(businessId => $businessId, getChatsRequest => $getChatsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getChatsRequest =  # GetChatsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение доступных чатов
    api_response = api_instance.get_chats(businessId, getChatsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getChats: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getChatsRequest = ; // GetChatsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getChats(businessId, getChatsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getChatsRequest *

description

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getFeed

Информация о прайс-листе

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.getFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeed: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Информация о прайс-листе
[apiInstance getFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(GetFeedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Информация о прайс-листе
                GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->getFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->getFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Информация о прайс-листе
    api_response = api_instance.get_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getFeed: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


getFeedIndexLogs

Отчет по индексации прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра `generationId`. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}/index-logs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs?limit=20&published_time_from=2013-10-20T19:20:30+01:00&published_time_to=2013-10-20T19:20:30+01:00&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Date publishedTimeFrom = new Date(); // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

final Date publishedTimeTo = new Date(); // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

final FeedIndexLogsStatusType status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    final result = await api_instance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedIndexLogs: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Date *publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
Date *publishedTimeTo = 2013-10-20T19:20:30+01:00; // Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
FeedIndexLogsStatusType *status = ; // Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

// Отчет по индексации прайс-листа
[apiInstance getFeedIndexLogsWith:campaignId
    feedId:feedId
    limit:limit
    publishedTimeFrom:publishedTimeFrom
    publishedTimeTo:publishedTimeTo
    status:status
              completionHandler: ^(GetFeedIndexLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var opts = {
  'limit': 20, // {Integer} Количество значений на одной странице.

  'publishedTimeFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

  'publishedTimeTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

  'status':  // {FeedIndexLogsStatusType} Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedIndexLogs(campaignId, feedId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedIndexLogsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var publishedTimeFrom = 2013-10-20T19:20:30+01:00;  // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional)  (default to null)
            var publishedTimeTo = 2013-10-20T19:20:30+01:00;  // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional)  (default to null)
            var status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional)  (default to null)

            try {
                // Отчет по индексации прайс-листа
                GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getFeedIndexLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$limit = 20; // Integer | Количество значений на одной странице.

$publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

$publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

$status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    $result = $api_instance->getFeedIndexLogs($campaignId, $feedId, $limit, $publishedTimeFrom, $publishedTimeTo, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $limit = 20; # Integer | Количество значений на одной странице.

my $publishedTimeFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

my $publishedTimeTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

my $status = ; # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


eval {
    my $result = $api_instance->getFeedIndexLogs(campaignId => $campaignId, feedId => $feedId, limit => $limit, publishedTimeFrom => $publishedTimeFrom, publishedTimeTo => $publishedTimeTo, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getFeedIndexLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
publishedTimeFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
publishedTimeTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
status =  # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

try:
    # Отчет по индексации прайс-листа
    api_response = api_instance.get_feed_index_logs(campaignId, feedId, limit=limit, publishedTimeFrom=publishedTimeFrom, publishedTimeTo=publishedTimeTo, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getFeedIndexLogs: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let limit = 20; // Integer
    let publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date
    let publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date
    let status = ; // FeedIndexLogsStatusType

    let mut context = FbyApi::Context::default();
    let result = client.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Query parameters
Name Description
limit
Integer (int32)
Количество значений на одной странице.
published_time_from
Date (date-time)
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.
published_time_to
Date (date-time)
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}
status
FeedIndexLogsStatusType
Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

Responses


getFeedbackAndCommentUpdates

Новые и обновленные отзывы о магазине

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает новые и обновленные отзывы о магазине на Маркете. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/feedback/updates

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feedback/updates?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&from_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final date fromDate = new date(); // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    final result = await api_instance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedbackAndCommentUpdates: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
date *fromDate = 2013-10-20; // Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

// Новые и обновленные отзывы о магазине
[apiInstance getFeedbackAndCommentUpdatesWith:campaignId
    pageToken:pageToken
    limit:limit
    fromDate:fromDate
              completionHandler: ^(GetFeedbackListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'fromDate': 2013-10-20 // {date} Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedbackAndCommentUpdates(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedbackAndCommentUpdatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var fromDate = 2013-10-20;  // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)

            try {
                // Новые и обновленные отзывы о магазине
                GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getFeedbackAndCommentUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    $result = $api_instance->getFeedbackAndCommentUpdates($campaignId, $pageToken, $limit, $fromDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getFeedbackAndCommentUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $fromDate = 2013-10-20; # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


eval {
    my $result = $api_instance->getFeedbackAndCommentUpdates(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, fromDate => $fromDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getFeedbackAndCommentUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
fromDate = 2013-10-20 # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

try:
    # Новые и обновленные отзывы о магазине
    api_response = api_instance.get_feedback_and_comment_updates(campaignId, pageToken=pageToken, limit=limit, fromDate=fromDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getFeedbackAndCommentUpdates: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let fromDate = 2013-10-20; // date

    let mut context = FbyApi::Context::default();
    let result = client.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
from_date
date (date)
Начальная дата обновления отзывов. Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты. Формат даты: `ГГГГ-ММ-ДД`.

Responses


getFeeds

Список прайс-листов магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeeds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getFeeds(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeeds: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список прайс-листов магазина
[apiInstance getFeedsWith:campaignId
              completionHandler: ^(GetFeedsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список прайс-листов магазина
                GetFeedsResponse result = apiInstance.getFeeds(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getFeeds($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getFeeds(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getFeeds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список прайс-листов магазина
    api_response = api_instance.get_feeds(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getFeeds: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getFeeds(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getFulfillmentWarehouses

Идентификаторы складов Маркета (FBY)

Возвращает список складов Маркета с их идентификаторами. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();

        try {
            GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFulfillmentWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getFulfillmentWarehouses();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFulfillmentWarehouses: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();

        try {
            GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getFulfillmentWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];

// Идентификаторы складов Маркета (FBY)
[apiInstance getFulfillmentWarehousesWithCompletionHandler: 
              ^(GetFulfillmentWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFulfillmentWarehouses(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFulfillmentWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();

            try {
                // Идентификаторы складов Маркета (FBY)
                GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getFulfillmentWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();

try {
    $result = $api_instance->getFulfillmentWarehouses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getFulfillmentWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();

eval {
    my $result = $api_instance->getFulfillmentWarehouses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getFulfillmentWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()

try:
    # Идентификаторы складов Маркета (FBY)
    api_response = api_instance.get_fulfillment_warehouses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getFulfillmentWarehouses: %s\n" % e)
extern crate FbyApi;

pub fn main() {

    let mut context = FbyApi::Context::default();
    let result = client.getFulfillmentWarehouses(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


getGoodsFeedbackComments

Получение комментариев к отзыву

Возвращает комментарии к отзыву. Результаты возвращаются постранично, одна страница содержит не более 20 комментариев. Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "feedbackId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbackComments: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsFeedbackCommentsRequest *getGoodsFeedbackCommentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение комментариев к отзыву
[apiInstance getGoodsFeedbackCommentsWith:businessId
    getGoodsFeedbackCommentsRequest:getGoodsFeedbackCommentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetGoodsFeedbackCommentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsFeedbackCommentsRequest = ; // {GetGoodsFeedbackCommentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbackCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение комментариев к отзыву
                GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getGoodsFeedbackComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getGoodsFeedbackComments($businessId, $getGoodsFeedbackCommentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getGoodsFeedbackComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsFeedbackCommentsRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackCommentsRequest->new(); # GetGoodsFeedbackCommentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getGoodsFeedbackComments(businessId => $businessId, getGoodsFeedbackCommentsRequest => $getGoodsFeedbackCommentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getGoodsFeedbackComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsFeedbackCommentsRequest =  # GetGoodsFeedbackCommentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение комментариев к отзыву
    api_response = api_instance.get_goods_feedback_comments(businessId, getGoodsFeedbackCommentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getGoodsFeedbackComments: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackCommentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsFeedbacks

Получение отзывов о товарах продавца

Возвращает все отзывы о товарах продавца по указанным фильтрам. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "ratingValues" : [ 0, 0, 0, 0, 0 ],
  "modelIds" : [ 6, 6, 6, 6, 6 ],
  "paid" : true,
  "reactionStatus" : "ALL",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetGoodsFeedbackRequest getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest | 

try {
    final result = await api_instance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbacks: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetGoodsFeedbackRequest *getGoodsFeedbackRequest = ; //  (optional)

// Получение отзывов о товарах продавца
[apiInstance getGoodsFeedbacksWith:businessId
    pageToken:pageToken
    limit:limit
    getGoodsFeedbackRequest:getGoodsFeedbackRequest
              completionHandler: ^(GetGoodsFeedbackResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getGoodsFeedbackRequest':  // {GetGoodsFeedbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbacks(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest |  (optional) 

            try {
                // Получение отзывов о товарах продавца
                GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getGoodsFeedbacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

try {
    $result = $api_instance->getGoodsFeedbacks($businessId, $pageToken, $limit, $getGoodsFeedbackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getGoodsFeedbacks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackRequest->new(); # GetGoodsFeedbackRequest | 

eval {
    my $result = $api_instance->getGoodsFeedbacks(businessId => $businessId, pageToken => $pageToken, limit => $limit, getGoodsFeedbackRequest => $getGoodsFeedbackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getGoodsFeedbacks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getGoodsFeedbackRequest =  # GetGoodsFeedbackRequest |  (optional)

try:
    # Получение отзывов о товарах продавца
    api_response = api_instance.get_goods_feedbacks(businessId, pageToken=pageToken, limit=limit, getGoodsFeedbackRequest=getGoodsFeedbackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getGoodsFeedbacks: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest

    let mut context = FbyApi::Context::default();
    let result = client.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsStats

Отчет по товарам

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/stats/skus

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/skus" \
 -d '{
  "shopSkus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsStatsRequest getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

try {
    final result = await api_instance.getGoodsStats(campaignId, getGoodsStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsStats: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsStatsRequest *getGoodsStatsRequest = ; // 

// Отчет по товарам
[apiInstance getGoodsStatsWith:campaignId
    getGoodsStatsRequest:getGoodsStatsRequest
              completionHandler: ^(GetGoodsStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsStatsRequest = ; // {GetGoodsStatsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsStats(campaignId, getGoodsStatsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

            try {
                // Отчет по товарам
                GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getGoodsStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

try {
    $result = $api_instance->getGoodsStats($campaignId, $getGoodsStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getGoodsStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsStatsRequest = WWW::OPenAPIClient::Object::GetGoodsStatsRequest->new(); # GetGoodsStatsRequest | 

eval {
    my $result = $api_instance->getGoodsStats(campaignId => $campaignId, getGoodsStatsRequest => $getGoodsStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getGoodsStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsStatsRequest =  # GetGoodsStatsRequest | 

try:
    # Отчет по товарам
    api_response = api_instance.get_goods_stats(campaignId, getGoodsStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getGoodsStats: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let getGoodsStatsRequest = ; // GetGoodsStatsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getGoodsStats(campaignId, getGoodsStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsStatsRequest *

Responses


getHiddenOffers

Информация о скрытых вами товарах

Возвращает список скрытых вами товаров для заданного магазина. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers?offer_id=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&offset=56&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Integer offset = new Integer(); // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHiddenOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор скрытого предложения.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Integer *offset = 56; // Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о скрытых вами товарах
[apiInstance getHiddenOffersWith:campaignId
    offerId:offerId
    pageToken:pageToken
    limit:limit
    offset:offset
    page:page
    pageSize:pageSize
              completionHandler: ^(GetHiddenOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор скрытого предложения.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'offset': 56, // {Integer} Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHiddenOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var offset = 56;  // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о скрытых вами товарах
                GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор скрытого предложения.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getHiddenOffers($campaignId, $offerId, $pageToken, $limit, $offset, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор скрытого предложения.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $offset = 56; # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getHiddenOffers(campaignId => $campaignId, offerId => $offerId, pageToken => $pageToken, limit => $limit, offset => $offset, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор скрытого предложения.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
offset = 56 # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о скрытых вами товарах
    api_response = api_instance.get_hidden_offers(campaignId, offerId=offerId, pageToken=pageToken, limit=limit, offset=offset, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getHiddenOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let offset = 56; // Integer
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор скрытого предложения.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
offset
Integer (int32)
Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOfferCardsContentStatus

Получение информации о заполненности карточек магазина

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * переданные характеристики товаров; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |**⚙️ Лимит:** 600 запросов в минуту| |-|


/businesses/{businessId}/offer-cards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ null, null, null, null, null ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest | 

try {
    final result = await api_instance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferCardsContentStatus: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferCardsContentStatusRequest getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

        try {
            GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferCardsContentStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferCardsContentStatusRequest *getOfferCardsContentStatusRequest = ; //  (optional)

// Получение информации о заполненности карточек магазина
[apiInstance getOfferCardsContentStatusWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferCardsContentStatusRequest:getOfferCardsContentStatusRequest
              completionHandler: ^(GetOfferCardsContentStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferCardsContentStatusRequest':  // {GetOfferCardsContentStatusRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferCardsContentStatus(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferCardsContentStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferCardsContentStatusRequest = new GetOfferCardsContentStatusRequest(); // GetOfferCardsContentStatusRequest |  (optional) 

            try {
                // Получение информации о заполненности карточек магазина
                GetOfferCardsContentStatusResponse result = apiInstance.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOfferCardsContentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest | 

try {
    $result = $api_instance->getOfferCardsContentStatus($businessId, $pageToken, $limit, $getOfferCardsContentStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOfferCardsContentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferCardsContentStatusRequest = WWW::OPenAPIClient::Object::GetOfferCardsContentStatusRequest->new(); # GetOfferCardsContentStatusRequest | 

eval {
    my $result = $api_instance->getOfferCardsContentStatus(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferCardsContentStatusRequest => $getOfferCardsContentStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOfferCardsContentStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferCardsContentStatusRequest =  # GetOfferCardsContentStatusRequest |  (optional)

try:
    # Получение информации о заполненности карточек магазина
    api_response = api_instance.get_offer_cards_content_status(businessId, pageToken=pageToken, limit=limit, getOfferCardsContentStatusRequest=getOfferCardsContentStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOfferCardsContentStatus: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferCardsContentStatusRequest = ; // GetOfferCardsContentStatusRequest

    let mut context = FbyApi::Context::default();
    let result = client.getOfferCardsContentStatus(businessId, pageToken, limit, getOfferCardsContentStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferCardsContentStatusRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappingEntries

Список товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров в каталоге магазина * 25)


/campaigns/{campaignId}/offer-mapping-entries

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries?offer_id=&shop_sku=&mapping_kind=&status=&availability=&category_id=&vendor=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор товара в каталоге.
final array[String] shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final OfferMappingKindType mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
final array[OfferProcessingStatusType] status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final array[OfferAvailabilityStatusType] availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[Integer] categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[String] vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор товара в каталоге. (optional) (default to null)
array[String] *shopSku = ; // Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
OfferMappingKindType *mappingKind = ; // Тип маппинга. (optional) (default to null)
array[OfferProcessingStatusType] *status = ; // Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[OfferAvailabilityStatusType] *availability = ; // Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[Integer] *categoryId = ; // Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[String] *vendor = ; // Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров в каталоге
[apiInstance getOfferMappingEntriesWith:campaignId
    offerId:offerId
    shopSku:shopSku
    mappingKind:mappingKind
    status:status
    availability:availability
    categoryId:categoryId
    vendor:vendor
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор товара в каталоге.
  'shopSku': , // {array[String]} Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'mappingKind': , // {OfferMappingKindType} Тип маппинга.
  'status': , // {array[OfferProcessingStatusType]} Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'availability': , // {array[OfferAvailabilityStatusType]} Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'categoryId': , // {array[Integer]} Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'vendor': , // {array[String]} Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappingEntries(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор товара в каталоге. (optional)  (default to null)
            var shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга. (optional)  (default to null)
            var status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров в каталоге
                GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор товара в каталоге.
$shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$mappingKind = ; // OfferMappingKindType | Тип маппинга.
$status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferMappingEntries($campaignId, $offerId, $shopSku, $mappingKind, $status, $availability, $categoryId, $vendor, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор товара в каталоге.
my $shopSku = []; # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $mappingKind = ; # OfferMappingKindType | Тип маппинга.
my $status = []; # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $availability = []; # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $categoryId = []; # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $vendor = []; # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferMappingEntries(campaignId => $campaignId, offerId => $offerId, shopSku => $shopSku, mappingKind => $mappingKind, status => $status, availability => $availability, categoryId => $categoryId, vendor => $vendor, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор товара в каталоге. (optional) (default to null)
shopSku =  # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
mappingKind =  # OfferMappingKindType | Тип маппинга. (optional) (default to null)
status =  # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
availability =  # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
categoryId =  # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
vendor =  # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров в каталоге
    api_response = api_instance.get_offer_mapping_entries(campaignId, offerId=offerId, shopSku=shopSku, mappingKind=mappingKind, status=status, availability=availability, categoryId=categoryId, vendor=vendor, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOfferMappingEntries: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let shopSku = ; // array[String]
    let mappingKind = ; // OfferMappingKindType
    let status = ; // array[OfferProcessingStatusType]
    let availability = ; // array[OfferAvailabilityStatusType]
    let categoryId = ; // array[Integer]
    let vendor = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор товара в каталоге.
shop_sku
array[String]
Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
mapping_kind
OfferMappingKindType
Тип маппинга.
status
array[OfferProcessingStatusType]
Фильтрация по статусу публикации товара: * `READY` — товар прошел модерацию. * `IN_WORK` — товар проходит модерацию. * `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * `OTHER` — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
availability
array[OfferAvailabilityStatusType]
Фильтрация по планам поставок товара: * `ACTIVE` — поставки будут. * `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
category_id
array[Integer]
Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md). Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
vendor
array[String]
Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL). В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferMappings

Информация о товарах в каталоге

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара. Можно использовать тремя способами: * задать список интересующих SKU; * задать фильтр — в этом случае результаты возвращаются постранично; * не передавать тело запроса, чтобы получить список всех товаров в каталоге. |**⚙️ Лимит:** 600 запросов в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOfferMappingsRequest getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest | 

try {
    final result = await api_instance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOfferMappingsRequest getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

        try {
            GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOfferMappingsRequest *getOfferMappingsRequest = ; //  (optional)

// Информация о товарах в каталоге
[apiInstance getOfferMappingsWith:businessId
    pageToken:pageToken
    limit:limit
    getOfferMappingsRequest:getOfferMappingsRequest
              completionHandler: ^(GetOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOfferMappingsRequest':  // {GetOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOfferMappingsRequest = new GetOfferMappingsRequest(); // GetOfferMappingsRequest |  (optional) 

            try {
                // Информация о товарах в каталоге
                GetOfferMappingsResponse result = apiInstance.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOfferMappingsRequest = ; // GetOfferMappingsRequest | 

try {
    $result = $api_instance->getOfferMappings($businessId, $pageToken, $limit, $getOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOfferMappingsRequest = WWW::OPenAPIClient::Object::GetOfferMappingsRequest->new(); # GetOfferMappingsRequest | 

eval {
    my $result = $api_instance->getOfferMappings(businessId => $businessId, pageToken => $pageToken, limit => $limit, getOfferMappingsRequest => $getOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOfferMappingsRequest =  # GetOfferMappingsRequest |  (optional)

try:
    # Информация о товарах в каталоге
    api_response = api_instance.get_offer_mappings(businessId, pageToken=pageToken, limit=limit, getOfferMappingsRequest=getOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOfferMappings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOfferMappingsRequest = ; // GetOfferMappingsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getOfferMappings(businessId, pageToken, limit, getOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferMappingsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferRecommendations

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. **1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.** Показывает, какие **цены для участия** нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#sponsored-discounts) **2. Оценка привлекательности цен на витрине.** Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#validation) В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/offers/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cofinancePriceFilter" : "SPECIFIED",
  "competitivenessFilter" : "OPTIMAL",
  "offerIds" : [ null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetOfferRecommendationsRequest getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferRecommendations: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetOfferRecommendationsRequest *getOfferRecommendationsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Рекомендации Маркета, касающиеся цен
[apiInstance getOfferRecommendationsWith:businessId
    getOfferRecommendationsRequest:getOfferRecommendationsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getOfferRecommendationsRequest = ; // {GetOfferRecommendationsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferRecommendations(businessId, getOfferRecommendationsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Рекомендации Маркета, касающиеся цен
                GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOfferRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferRecommendations($businessId, $getOfferRecommendationsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getOfferRecommendationsRequest = WWW::OPenAPIClient::Object::GetOfferRecommendationsRequest->new(); # GetOfferRecommendationsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferRecommendations(businessId => $businessId, getOfferRecommendationsRequest => $getOfferRecommendationsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOfferRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getOfferRecommendationsRequest =  # GetOfferRecommendationsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Рекомендации Маркета, касающиеся цен
    api_response = api_instance.get_offer_recommendations(businessId, getOfferRecommendationsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOfferRecommendations: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferRecommendationsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOffers

Предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?query=query_example&feedId=789&shopCategoryId=shopCategoryId_example¤cy=&matched=true&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String query = new String(); // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final String shopCategoryId = new String(); // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

final Boolean matched = new Boolean(); // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *query = query_example; // Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
String *shopCategoryId = shopCategoryId_example; // Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
CurrencyType *currency = ; // Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
Boolean *matched = true; // Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Предложения магазина
[apiInstance getOffersWith:campaignId
    query:query
    feedId:feedId
    shopCategoryId:shopCategoryId
    currency:currency
    matched:matched
    page:page
    pageSize:pageSize
              completionHandler: ^(GetOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'query': query_example, // {String} Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'shopCategoryId': shopCategoryId_example, // {String} Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

  'currency': , // {CurrencyType} Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

  'matched': true, // {Boolean} Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var query = query_example;  // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional)  (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var shopCategoryId = shopCategoryId_example;  // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional)  (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional)  (default to null)
            var matched = true;  // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Предложения магазина
                GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

$feedId = 789; // Long | Идентификатор прайс-листа.
$shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

$currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

$matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getOffers($campaignId, $query, $feedId, $shopCategoryId, $currency, $matched, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $query = query_example; # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $shopCategoryId = shopCategoryId_example; # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

my $currency = ; # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

my $matched = true; # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getOffers(campaignId => $campaignId, query => $query, feedId => $feedId, shopCategoryId => $shopCategoryId, currency => $currency, matched => $matched, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
query = query_example # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
shopCategoryId = shopCategoryId_example # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
currency =  # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
matched = true # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Предложения магазина
    api_response = api_instance.get_offers(campaignId, query=query, feedId=feedId, shopCategoryId=shopCategoryId, currency=currency, matched=matched, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let query = query_example; // String
    let feedId = 789; // Long
    let shopCategoryId = shopCategoryId_example; // String
    let currency = ; // CurrencyType
    let matched = true; // Boolean
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
query
String
Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId
Long (int64)
Идентификатор прайс-листа.
shopCategoryId
String
Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency
CurrencyType
Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.
matched
Boolean
Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getOrder

Информация об одном заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrder");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrder(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrder: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация об одном заказе
[apiInstance getOrderWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация об одном заказе
                GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrder($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrder(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация об одном заказе
    api_response = api_instance.get_order(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOrder: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getOrder(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessBuyerInfo

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY`, `PICKUP` или `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/business-buyer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/business-buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessBuyerInfo: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — юридическом лице
[apiInstance getOrderBusinessBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — юридическом лице
                GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOrderBusinessBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOrderBusinessBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — юридическом лице
    api_response = api_instance.get_order_business_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOrderBusinessBuyerInfo: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getOrderBusinessBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessDocumentsInfo

Информация о документах

Возвращает информацию о документах по идентификатору заказа. Получить данные можно после того, как заказ перейдет в статус `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/documents

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessDocumentsInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessDocumentsInfo: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о документах
[apiInstance getOrderBusinessDocumentsInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessDocumentsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessDocumentsInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessDocumentsInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о документах
                GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOrderBusinessDocumentsInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessDocumentsInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessDocumentsInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOrderBusinessDocumentsInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о документах
    api_response = api_instance.get_order_business_documents_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOrderBusinessDocumentsInfo: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getOrderBusinessDocumentsInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrders

Информация о нескольких заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * идентификаторам заказов; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) (если у вас есть идентификатор заказа) или запроса отчета по заказам [POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md). Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Для навигации по страницам используйте параметры `page_token` и `limit`. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders?orderIds=&status=&substatus=&fromDate=2013-10-20&toDate=2013-10-20&supplierShipmentDateFrom=2013-10-20&supplierShipmentDateTo=2013-10-20&updatedAtFrom=2013-10-20T19:20:30+01:00&updatedAtTo=2013-10-20T19:20:30+01:00&dispatchType=&fake=true&hasCis=true&onlyWaitingForCancellationApprove=true&onlyEstimatedDelivery=true&buyerType=&page=56&pageSize=56&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FbyApi#getOrders"); e.printStackTrace(); } } }
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[Long] orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. final set[OrderStatusType] status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. final set[OrderSubstatusType] substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. final date fromDate = new date(); // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. final date toDate = new date(); // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. final date supplierShipmentDateFrom = new date(); // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final date supplierShipmentDateTo = new date(); // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final Date updatedAtFrom = new Date(); // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final Date updatedAtTo = new Date(); // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final OrderDeliveryDispatchType dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки final Boolean fake = new Boolean(); // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. final Boolean hasCis = new Boolean(); // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. final Boolean onlyWaitingForCancellationApprove = new Boolean(); // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). final Boolean onlyEstimatedDelivery = new Boolean(); // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. final OrderBuyerType buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. final Integer page = new Integer(); // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. final Integer pageSize = new Integer(); // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. final String pageToken = new String(); // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. final Integer limit = new Integer(); // Integer | Количество значений на одной странице. try { final result = await api_instance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); print(result); } catch (e) { print('Exception when calling DefaultApi->getOrders: $e\n'); }
import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FbyApi#getOrders"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[Long] *orderIds = ; // Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) set[OrderStatusType] *status = ; // Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) set[OrderSubstatusType] *substatus = ; // Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) date *fromDate = 2013-10-20; // Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) date *toDate = 2013-10-20; // Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) date *supplierShipmentDateFrom = 2013-10-20; // Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) date *supplierShipmentDateTo = 2013-10-20; // Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtFrom = 2013-10-20T19:20:30+01:00; // Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtTo = 2013-10-20T19:20:30+01:00; // Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) OrderDeliveryDispatchType *dispatchType = ; // Способ отгрузки (optional) (default to null) Boolean *fake = true; // Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) Boolean *hasCis = true; // Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) Boolean *onlyWaitingForCancellationApprove = true; // **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) Boolean *onlyEstimatedDelivery = true; // Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) OrderBuyerType *buyerType = ; // Фильтрация заказов по типу покупателя. (optional) (default to null) Integer *page = 56; // Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) Integer *pageSize = 56; // Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) Integer *limit = 20; // Количество значений на одной странице. (optional) (default to null) // Информация о нескольких заказах [apiInstance getOrdersWith:campaignId orderIds:orderIds status:status substatus:substatus fromDate:fromDate toDate:toDate supplierShipmentDateFrom:supplierShipmentDateFrom supplierShipmentDateTo:supplierShipmentDateTo updatedAtFrom:updatedAtFrom updatedAtTo:updatedAtTo dispatchType:dispatchType fake:fake hasCis:hasCis onlyWaitingForCancellationApprove:onlyWaitingForCancellationApprove onlyEstimatedDelivery:onlyEstimatedDelivery buyerType:buyerType page:page pageSize:pageSize pageToken:pageToken limit:limit completionHandler: ^(GetOrdersResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'orderIds': , // {array[Long]} Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. 'status': , // {set[OrderStatusType]} Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. 'substatus': , // {set[OrderSubstatusType]} Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. 'fromDate': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. 'toDate': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. 'supplierShipmentDateFrom': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'supplierShipmentDateTo': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'updatedAtFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'updatedAtTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'dispatchType': , // {OrderDeliveryDispatchType} Способ отгрузки 'fake': true, // {Boolean} Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. 'hasCis': true, // {Boolean} Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. 'onlyWaitingForCancellationApprove': true, // {Boolean} **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). 'onlyEstimatedDelivery': true, // {Boolean} Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. 'buyerType': , // {OrderBuyerType} Фильтрация заказов по типу покупателя. 'page': 56, // {Integer} Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageSize': 56, // {Integer} Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. 'limit': 20 // {Integer} Количество значений на одной странице. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getOrders(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) var status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) var toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) var supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) var fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) var hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) var onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) var onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) var buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) var page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) var pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) var limit = 20; // Integer | Количество значений на одной странице. (optional) (default to null) try { // Информация о нескольких заказах GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling FbyApi.getOrders: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. $status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. $substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. $fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. $toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. $supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки $fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. $hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. $onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). $onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. $buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. $page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. $pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. $limit = 20; // Integer | Количество значений на одной странице. try { $result = $api_instance->getOrders($campaignId, $orderIds, $status, $substatus, $fromDate, $toDate, $supplierShipmentDateFrom, $supplierShipmentDateTo, $updatedAtFrom, $updatedAtTo, $dispatchType, $fake, $hasCis, $onlyWaitingForCancellationApprove, $onlyEstimatedDelivery, $buyerType, $page, $pageSize, $pageToken, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling FbyApi->getOrders: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderIds = []; # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. my $status = []; # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. my $substatus = []; # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. my $fromDate = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. my $toDate = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. my $supplierShipmentDateFrom = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $supplierShipmentDateTo = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $updatedAtFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $updatedAtTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $dispatchType = ; # OrderDeliveryDispatchType | Способ отгрузки my $fake = true; # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. my $hasCis = true; # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. my $onlyWaitingForCancellationApprove = true; # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). my $onlyEstimatedDelivery = true; # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. my $buyerType = ; # OrderBuyerType | Фильтрация заказов по типу покупателя. my $page = 56; # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageSize = 56; # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. my $limit = 20; # Integer | Количество значений на одной странице. eval { my $result = $api_instance->getOrders(campaignId => $campaignId, orderIds => $orderIds, status => $status, substatus => $substatus, fromDate => $fromDate, toDate => $toDate, supplierShipmentDateFrom => $supplierShipmentDateFrom, supplierShipmentDateTo => $supplierShipmentDateTo, updatedAtFrom => $updatedAtFrom, updatedAtTo => $updatedAtTo, dispatchType => $dispatchType, fake => $fake, hasCis => $hasCis, onlyWaitingForCancellationApprove => $onlyWaitingForCancellationApprove, onlyEstimatedDelivery => $onlyEstimatedDelivery, buyerType => $buyerType, page => $page, pageSize => $pageSize, pageToken => $pageToken, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling FbyApi->getOrders: $@\n"; }
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderIds =  # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) status = # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) substatus = # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) fromDate = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) toDate = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) supplierShipmentDateFrom = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) supplierShipmentDateTo = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) updatedAtFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) updatedAtTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) dispatchType = # OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) fake = true # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) hasCis = true # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) onlyWaitingForCancellationApprove = true # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) onlyEstimatedDelivery = true # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) buyerType = # OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) page = 56 # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) pageSize = 56 # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) limit = 20 # Integer | Количество значений на одной странице. (optional) (default to null) try: # Информация о нескольких заказах api_response = api_instance.get_orders(campaignId, orderIds=orderIds, status=status, substatus=substatus, fromDate=fromDate, toDate=toDate, supplierShipmentDateFrom=supplierShipmentDateFrom, supplierShipmentDateTo=supplierShipmentDateTo, updatedAtFrom=updatedAtFrom, updatedAtTo=updatedAtTo, dispatchType=dispatchType, fake=fake, hasCis=hasCis, onlyWaitingForCancellationApprove=onlyWaitingForCancellationApprove, onlyEstimatedDelivery=onlyEstimatedDelivery, buyerType=buyerType, page=page, pageSize=pageSize, pageToken=pageToken, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling FbyApi->getOrders: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderIds = ; // array[Long]
    let status = ; // set[OrderStatusType]
    let substatus = ; // set[OrderSubstatusType]
    let fromDate = 2013-10-20; // date
    let toDate = 2013-10-20; // date
    let supplierShipmentDateFrom = 2013-10-20; // date
    let supplierShipmentDateTo = 2013-10-20; // date
    let updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date
    let updatedAtTo = 2013-10-20T19:20:30+01:00; // Date
    let dispatchType = ; // OrderDeliveryDispatchType
    let fake = true; // Boolean
    let hasCis = true; // Boolean
    let onlyWaitingForCancellationApprove = true; // Boolean
    let onlyEstimatedDelivery = true; // Boolean
    let buyerType = ; // OrderBuyerType
    let page = 56; // Integer
    let pageSize = 56; // Integer
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
orderIds
array[Long] (int64)
Фильтрация заказов по идентификаторам. <br><br> ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
status
set[OrderStatusType]
Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus
set[OrderSubstatusType]
Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.
fromDate
date (date)
Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
toDate
date (date)
Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.
supplierShipmentDateFrom
date (date)
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo
date (date)
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
updatedAtFrom
Date (date-time)
Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo
Date (date-time)
Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
dispatchType
OrderDeliveryDispatchType
Способ отгрузки
fake
Boolean
Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
hasCis
Boolean
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
onlyWaitingForCancellationApprove
Boolean
**Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
onlyEstimatedDelivery
Boolean
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
buyerType
OrderBuyerType
Фильтрация заказов по типу покупателя.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOrdersStats

Детальная информация по заказам

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п. {% note info "" %} Раньше генерация детальной информации по заказам называлась **Отчет по заказам**. Сейчас это новый отчет. [Подробнее об отчете](../../reference/reports/generateUnitedOrdersReport.md) {% endnote %} В одном запросе можно получить информацию не более чем по 200 заказам. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/stats/orders

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "updateTo" : "2000-01-23",
  "updateFrom" : "2000-01-23",
  "hasCis" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "CANCELLED_BEFORE_PROCESSING", "CANCELLED_BEFORE_PROCESSING" ],
  "orders" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOrdersStatsRequest getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest | 

try {
    final result = await api_instance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrdersStats: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOrdersStatsRequest *getOrdersStatsRequest = ; //  (optional)

// Детальная информация по заказам
[apiInstance getOrdersStatsWith:campaignId
    pageToken:pageToken
    limit:limit
    getOrdersStatsRequest:getOrdersStatsRequest
              completionHandler: ^(GetOrdersStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOrdersStatsRequest':  // {GetOrdersStatsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrdersStats(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest |  (optional) 

            try {
                // Детальная информация по заказам
                GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getOrdersStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

try {
    $result = $api_instance->getOrdersStats($campaignId, $pageToken, $limit, $getOrdersStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getOrdersStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOrdersStatsRequest = WWW::OPenAPIClient::Object::GetOrdersStatsRequest->new(); # GetOrdersStatsRequest | 

eval {
    my $result = $api_instance->getOrdersStats(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getOrdersStatsRequest => $getOrdersStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getOrdersStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOrdersStatsRequest =  # GetOrdersStatsRequest |  (optional)

try:
    # Детальная информация по заказам
    api_response = api_instance.get_orders_stats(campaignId, pageToken=pageToken, limit=limit, getOrdersStatsRequest=getOrdersStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getOrdersStats: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOrdersStatsRequest = ; // GetOrdersStatsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOrdersStatsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPrices

Список цен

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST campaigns/{campaignId}/offer-prices](../../reference/assortment/getPricesByOfferIds.md). {% endnote %} Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом. {% note info %} Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов. {% endnote %} Способы установки цен описаны [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/assortment/operations/prices.html). |**⚙️ Лимит:** ```(количество товаров партнера на витрине) * 25``` товаров в сутки| |-|


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&archived=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Boolean archived = new Boolean(); // Boolean | Фильтр по нахождению в архиве.

try {
    final result = await api_instance.getPrices(campaignId, pageToken, limit, archived);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Boolean *archived = true; // Фильтр по нахождению в архиве. (optional) (default to false)

// Список цен
[apiInstance getPricesWith:campaignId
    pageToken:pageToken
    limit:limit
    archived:archived
              completionHandler: ^(GetPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'archived': true // {Boolean} Фильтр по нахождению в архиве.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrices(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var archived = true;  // Boolean | Фильтр по нахождению в архиве. (optional)  (default to false)

            try {
                // Список цен
                GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$archived = true; // Boolean | Фильтр по нахождению в архиве.

try {
    $result = $api_instance->getPrices($campaignId, $pageToken, $limit, $archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $archived = true; # Boolean | Фильтр по нахождению в архиве.

eval {
    my $result = $api_instance->getPrices(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, archived => $archived);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
archived = true # Boolean | Фильтр по нахождению в архиве. (optional) (default to false)

try:
    # Список цен
    api_response = api_instance.get_prices(campaignId, pageToken=pageToken, limit=limit, archived=archived)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getPrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let archived = true; // Boolean

    let mut context = FbyApi::Context::default();
    let result = client.getPrices(campaignId, pageToken, limit, archived, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
archived
Boolean
Фильтр по нахождению в архиве.

Responses


getPricesByOfferIds

Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине. {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для просмотра базовых цен используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров на витрине * 25)


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest | 

try {
    final result = await api_instance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPricesByOfferIds: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetPricesByOfferIdsRequest *getPricesByOfferIdsRequest = ; //  (optional)

// Просмотр цен на указанные товары в магазине
[apiInstance getPricesByOfferIdsWith:campaignId
    pageToken:pageToken
    limit:limit
    getPricesByOfferIdsRequest:getPricesByOfferIdsRequest
              completionHandler: ^(GetPricesByOfferIdsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getPricesByOfferIdsRequest':  // {GetPricesByOfferIdsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPricesByOfferIds(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesByOfferIdsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest |  (optional) 

            try {
                // Просмотр цен на указанные товары в магазине
                GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getPricesByOfferIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

try {
    $result = $api_instance->getPricesByOfferIds($campaignId, $pageToken, $limit, $getPricesByOfferIdsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getPricesByOfferIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getPricesByOfferIdsRequest = WWW::OPenAPIClient::Object::GetPricesByOfferIdsRequest->new(); # GetPricesByOfferIdsRequest | 

eval {
    my $result = $api_instance->getPricesByOfferIds(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getPricesByOfferIdsRequest => $getPricesByOfferIdsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getPricesByOfferIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getPricesByOfferIdsRequest =  # GetPricesByOfferIdsRequest |  (optional)

try:
    # Просмотр цен на указанные товары в магазине
    api_response = api_instance.get_prices_by_offer_ids(campaignId, pageToken=pageToken, limit=limit, getPricesByOfferIdsRequest=getPricesByOfferIdsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getPricesByOfferIds: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPricesByOfferIdsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromoOffers

Получение списка товаров, которые участвуют или могут участвовать в акции

Возвращает список товаров, которые участвуют или могут участвовать в акции. {% note warning %} В параметре `limit` не передавайте значение больше 500. {% endnote %} |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "statusType" : "MANUALLY_ADDED",
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromoOffersRequest getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromoOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromoOffersRequest *getPromoOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение списка товаров, которые участвуют или могут участвовать в акции
[apiInstance getPromoOffersWith:businessId
    getPromoOffersRequest:getPromoOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetPromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getPromoOffersRequest = ; // {GetPromoOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromoOffers(businessId, getPromoOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение списка товаров, которые участвуют или могут участвовать в акции
                GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getPromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromoOffersRequest = ; // GetPromoOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getPromoOffers($businessId, $getPromoOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getPromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromoOffersRequest = WWW::OPenAPIClient::Object::GetPromoOffersRequest->new(); # GetPromoOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getPromoOffers(businessId => $businessId, getPromoOffersRequest => $getPromoOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getPromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromoOffersRequest =  # GetPromoOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение списка товаров, которые участвуют или могут участвовать в акции
    api_response = api_instance.get_promo_offers(businessId, getPromoOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getPromoOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromoOffersRequest = ; // GetPromoOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromoOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromos

Получение списка акций

Возвращает информацию об акциях Маркета. По умолчанию возвращаются акции, в которых продавец участвует или может принять участие. Чтобы получить текущие или завершенные акции, передайте параметр `participation`. Типы акций, которые возвращаются в ответе: * прямая скидка; * флеш-акция; * скидка по промокоду. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/promos

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos" \
 -d '{
  "participation" : "PARTICIPATING_NOW",
  "mechanics" : "DIRECT_DISCOUNT"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPromos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromosRequest getPromosRequest = new GetPromosRequest(); // GetPromosRequest | 

try {
    final result = await api_instance.getPromos(businessId, getPromosRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromos: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getPromos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromosRequest *getPromosRequest = ; //  (optional)

// Получение списка акций
[apiInstance getPromosWith:businessId
    getPromosRequest:getPromosRequest
              completionHandler: ^(GetPromosResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getPromosRequest':  // {GetPromosRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromos(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromosExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromosRequest = new GetPromosRequest(); // GetPromosRequest |  (optional) 

            try {
                // Получение списка акций
                GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getPromos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromosRequest = ; // GetPromosRequest | 

try {
    $result = $api_instance->getPromos($businessId, $getPromosRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getPromos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromosRequest = WWW::OPenAPIClient::Object::GetPromosRequest->new(); # GetPromosRequest | 

eval {
    my $result = $api_instance->getPromos(businessId => $businessId, getPromosRequest => $getPromosRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getPromos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromosRequest =  # GetPromosRequest |  (optional)

try:
    # Получение списка акций
    api_response = api_instance.get_promos(businessId, getPromosRequest=getPromosRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getPromos: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromosRequest = ; // GetPromosRequest

    let mut context = FbyApi::Context::default();
    let result = client.getPromos(businessId, getPromosRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromosRequest

Responses


getQualityRatings

Индекс качества магазинов

Возвращает значение индекса качества магазинов и его составляющие. Подробнее об индексе качества читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/quality/score/). |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/ratings/quality

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality" \
 -d '{
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 0, 0, 0, 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQualityRatingRequest getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

try {
    final result = await api_instance.getQualityRatings(businessId, getQualityRatingRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQualityRatingRequest *getQualityRatingRequest = ; // 

// Индекс качества магазинов
[apiInstance getQualityRatingsWith:businessId
    getQualityRatingRequest:getQualityRatingRequest
              completionHandler: ^(GetQualityRatingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQualityRatingRequest = ; // {GetQualityRatingRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatings(businessId, getQualityRatingRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

            try {
                // Индекс качества магазинов
                GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getQualityRatings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQualityRatingRequest = ; // GetQualityRatingRequest | 

try {
    $result = $api_instance->getQualityRatings($businessId, $getQualityRatingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getQualityRatings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQualityRatingRequest = WWW::OPenAPIClient::Object::GetQualityRatingRequest->new(); # GetQualityRatingRequest | 

eval {
    my $result = $api_instance->getQualityRatings(businessId => $businessId, getQualityRatingRequest => $getQualityRatingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getQualityRatings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQualityRatingRequest =  # GetQualityRatingRequest | 

try:
    # Индекс качества магазинов
    api_response = api_instance.get_quality_ratings(businessId, getQualityRatingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getQualityRatings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getQualityRatingRequest = ; // GetQualityRatingRequest

    let mut context = FbyApi::Context::default();
    let result = client.getQualityRatings(businessId, getQualityRatingRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQualityRatingRequest *

Responses


getReportInfo

Получение заданного отчета

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. [Инструкция](../../step-by-step/reports.md) |**⚙️ Лимит:** 100 запросов в минуту| |-|


/reports/info/{reportId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/reports/info/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportId = new String(); // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    final result = await api_instance.getReportInfo(reportId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReportInfo: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
String *reportId = reportId_example; // Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

// Получение заданного отчета
[apiInstance getReportInfoWith:reportId
              completionHandler: ^(GetReportInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var reportId = reportId_example; // {String} Идентификатор отчета, который вы получили после запуска генерации.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportInfo(reportId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReportInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var reportId = reportId_example;  // String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

            try {
                // Получение заданного отчета
                GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getReportInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    $result = $api_instance->getReportInfo($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getReportInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $reportId = reportId_example; # String | Идентификатор отчета, который вы получили после запуска генерации.


eval {
    my $result = $api_instance->getReportInfo(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getReportInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
reportId = reportId_example # String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

try:
    # Получение заданного отчета
    api_response = api_instance.get_report_info(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getReportInfo: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let reportId = reportId_example; // String

    let mut context = FbyApi::Context::default();
    let result = client.getReportInfo(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
reportId*
String
Идентификатор отчета, который вы получили после запуска генерации.
Required

Responses


getReturn

Информация о невыкупе или возврате

Получает информацию по одному невыкупу или возврату. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturn");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturn(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturn: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Информация о невыкупе или возврате
[apiInstance getReturnWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(GetReturnResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturn(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Информация о невыкупе или возврате
                GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getReturn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturn($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturn(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Информация о невыкупе или возврате
    api_response = api_instance.get_return(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getReturn: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.getReturn(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnPhoto

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final Long itemId = new Long(); // Long | Идентификатор товара в возврате.
final String imageHash = new String(); // String | Хеш ссылки изображения для загрузки.

try {
    final result = await api_instance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnPhoto: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
Long *itemId = 789; // Идентификатор товара в возврате. (default to null)
String *imageHash = imageHash_example; // Хеш ссылки изображения для загрузки. (default to null)

// Получение фотографии возврата
[apiInstance getReturnPhotoWith:campaignId
    orderId:orderId
    returnId:returnId
    itemId:itemId
    imageHash:imageHash
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var itemId = 789; // {Long} Идентификатор товара в возврате.
var imageHash = imageHash_example; // {String} Хеш ссылки изображения для загрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnPhotoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var itemId = 789;  // Long | Идентификатор товара в возврате. (default to null)
            var imageHash = imageHash_example;  // String | Хеш ссылки изображения для загрузки. (default to null)

            try {
                // Получение фотографии возврата
                File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getReturnPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$itemId = 789; // Long | Идентификатор товара в возврате.
$imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

try {
    $result = $api_instance->getReturnPhoto($campaignId, $orderId, $returnId, $itemId, $imageHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $itemId = 789; # Long | Идентификатор товара в возврате.
my $imageHash = imageHash_example; # String | Хеш ссылки изображения для загрузки.

eval {
    my $result = $api_instance->getReturnPhoto(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, itemId => $itemId, imageHash => $imageHash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getReturnPhoto: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
itemId = 789 # Long | Идентификатор товара в возврате. (default to null)
imageHash = imageHash_example # String | Хеш ссылки изображения для загрузки. (default to null)

try:
    # Получение фотографии возврата
    api_response = api_instance.get_return_photo(campaignId, orderId, returnId, itemId, imageHash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getReturnPhoto: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let itemId = 789; // Long
    let imageHash = imageHash_example; // String

    let mut context = FbyApi::Context::default();
    let result = client.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
itemId*
Long (int64)
Идентификатор товара в возврате.
Required
imageHash*
String
Хеш ссылки изображения для загрузки.
Required

Responses


getReturns

Список невыкупов и возвратов

Получает список невыкупов и возвратов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос [GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}](../../reference/orders/getReturn.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/returns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&orderIds=&statuses=STARTED_BY_USER,WAITING_FOR_DECISION&type=&fromDate=2022-10-31&toDate=2022-11-30&from_date=2022-10-31&to_date=2022-11-30"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final array[Long] orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

final array[RefundStatusType] statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

final ReturnType type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

final date fromDate = new date(); // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date toDate = new date(); // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date fromDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

final date toDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    final result = await api_instance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturns: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getReturns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
array[Long] *orderIds = ; // Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
array[RefundStatusType] *statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
ReturnType *type = ; // Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
date *fromDate = 2022-10-31; // Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *toDate = 2022-11-30; // Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *fromDate2 = 2022-10-31; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
date *toDate2 = 2022-11-30; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

// Список невыкупов и возвратов
[apiInstance getReturnsWith:campaignId
    pageToken:pageToken
    limit:limit
    orderIds:orderIds
    statuses:statuses
    type:type
    fromDate:fromDate
    toDate:toDate
    fromDate2:fromDate2
    toDate2:toDate2
              completionHandler: ^(GetReturnsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'orderIds': , // {array[Long]} Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

  'statuses': STARTED_BY_USER,WAITING_FOR_DECISION, // {array[RefundStatusType]} Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

  'type': , // {ReturnType} Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

  'fromDate': 2022-10-31, // {date} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'toDate': 2022-11-30, // {date} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'fromDate2': 2022-10-31, // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

  'toDate2': 2022-11-30 // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturns(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional)  (default to null)
            var statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional)  (default to null)
            var type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional)  (default to null)
            var fromDate = 2022-10-31;  // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var toDate = 2022-11-30;  // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var fromDate2 = 2022-10-31;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)
            var toDate2 = 2022-11-30;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)

            try {
                // Список невыкупов и возвратов
                GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getReturns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

$type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

$fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

$toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    $result = $api_instance->getReturns($campaignId, $pageToken, $limit, $orderIds, $statuses, $type, $fromDate, $toDate, $fromDate2, $toDate2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getReturns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $orderIds = []; # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

my $statuses = [STARTED_BY_USER,WAITING_FOR_DECISION]; # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

my $type = ; # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

my $fromDate = 2022-10-31; # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $toDate = 2022-11-30; # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $fromDate2 = 2022-10-31; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

my $toDate2 = 2022-11-30; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


eval {
    my $result = $api_instance->getReturns(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, orderIds => $orderIds, statuses => $statuses, type => $type, fromDate => $fromDate, toDate => $toDate, fromDate2 => $fromDate2, toDate2 => $toDate2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getReturns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
orderIds =  # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
statuses = STARTED_BY_USER,WAITING_FOR_DECISION # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
type =  # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
fromDate = 2022-10-31 # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
toDate = 2022-11-30 # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
fromDate2 = 2022-10-31 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
toDate2 = 2022-11-30 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

try:
    # Список невыкупов и возвратов
    api_response = api_instance.get_returns(campaignId, pageToken=pageToken, limit=limit, orderIds=orderIds, statuses=statuses, type=type, fromDate=fromDate, toDate=toDate, fromDate2=fromDate2, toDate2=toDate2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getReturns: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let orderIds = ; // array[Long]
    let statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType]
    let type = ; // ReturnType
    let fromDate = 2022-10-31; // date
    let toDate = 2022-11-30; // date
    let fromDate2 = 2022-10-31; // date
    let toDate2 = 2022-11-30; // date

    let mut context = FbyApi::Context::default();
    let result = client.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
orderIds
array[Long] (int64)
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
statuses
array[RefundStatusType]
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
type
ReturnType
Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.
fromDate
date (date)
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
toDate
date (date)
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
from_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `fromDate`. {% endnote %} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
to_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `toDate`. {% endnote %} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Responses


getStocks

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для всех моделей) и об [оборачиваемости](*turnover) товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте `true` в поле `withTurnover`. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке Маркета для продавцов https://yandex.ru/support/marketplace/analytics/turnover.html.)


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "withTurnover" : false,
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetWarehouseStocksRequest getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest | 

try {
    final result = await api_instance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStocks: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetWarehouseStocksRequest *getWarehouseStocksRequest = ; //  (optional)

// Информация об остатках и оборачиваемости
[apiInstance getStocksWith:campaignId
    pageToken:pageToken
    limit:limit
    getWarehouseStocksRequest:getWarehouseStocksRequest
              completionHandler: ^(GetWarehouseStocksResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getWarehouseStocksRequest':  // {GetWarehouseStocksRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStocks(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest |  (optional) 

            try {
                // Информация об остатках и оборачиваемости
                GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

try {
    $result = $api_instance->getStocks($campaignId, $pageToken, $limit, $getWarehouseStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getWarehouseStocksRequest = WWW::OPenAPIClient::Object::GetWarehouseStocksRequest->new(); # GetWarehouseStocksRequest | 

eval {
    my $result = $api_instance->getStocks(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getWarehouseStocksRequest => $getWarehouseStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getWarehouseStocksRequest =  # GetWarehouseStocksRequest |  (optional)

try:
    # Информация об остатках и оборачиваемости
    api_response = api_instance.get_stocks(campaignId, pageToken=pageToken, limit=limit, getWarehouseStocksRequest=getWarehouseStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getStocks: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getWarehouseStocksRequest = ; // GetWarehouseStocksRequest

    let mut context = FbyApi::Context::default();
    let result = client.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getWarehouseStocksRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappingEntries

Рекомендованные карточки для товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/suggestions](../../reference/business-assortment/getSuggestedOfferMappings.md). {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/updates](../../reference/offer-mappings/updateOfferMappingEntries.md). В одном запросе можно получить не более 500 рекомендаций. |**⚙️ Лимит:** 100 000 рекомендаций в час| |-|


/campaigns/{campaignId}/offer-mapping-entries/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions" \
 -d '{
  "offers" : [ {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingEntriesRequest *getSuggestedOfferMappingEntriesRequest = ; // 

// Рекомендованные карточки для товаров
[apiInstance getSuggestedOfferMappingEntriesWith:campaignId
    getSuggestedOfferMappingEntriesRequest:getSuggestedOfferMappingEntriesRequest
              completionHandler: ^(GetSuggestedOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getSuggestedOfferMappingEntriesRequest = ; // {GetSuggestedOfferMappingEntriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

            try {
                // Рекомендованные карточки для товаров
                GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getSuggestedOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappingEntries($campaignId, $getSuggestedOfferMappingEntriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getSuggestedOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingEntriesRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingEntriesRequest->new(); # GetSuggestedOfferMappingEntriesRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappingEntries(campaignId => $campaignId, getSuggestedOfferMappingEntriesRequest => $getSuggestedOfferMappingEntriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getSuggestedOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingEntriesRequest =  # GetSuggestedOfferMappingEntriesRequest | 

try:
    # Рекомендованные карточки для товаров
    api_response = api_instance.get_suggested_offer_mapping_entries(campaignId, getSuggestedOfferMappingEntriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getSuggestedOfferMappingEntries: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest

    let mut context = FbyApi::Context::default();
    let result = client.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingEntriesRequest *

Responses


getSuggestedOfferMappings

Просмотр карточек на Маркете, которые подходят вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами. Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным. **Как пользоваться запросом** 1. Передайте Маркету список товаров, которые нужно проверить. 2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией. 3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида `https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>`. 4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать `marketSKU`, который ему подходит по вашему мнению. {% note info "𝓠 Как определить `marketSku` товара, найденного на Маркете?" %} 𝓐 Он есть в адресе страницы товара — расположен после `sku=`. Например, `https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016` {% endnote %} |**⚙️ Лимит:** 100 000 товаров в час| |-|


/businesses/{businessId}/offer-mappings/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/suggestions" \
 -d '{
  "offers" : [ {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  }, {
    "vendor" : "LEVENHUK",
    "basicPrice" : {
      "value" : 0.9301444243932576
    },
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "offerId" : "offerId",
    "description" : "description",
    "category" : "category",
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "vendorCode" : "VNDR-0005A"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingsRequest getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

        try {
            GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingsRequest *getSuggestedOfferMappingsRequest = ; //  (optional)

// Просмотр карточек на Маркете, которые подходят вашим товарам
[apiInstance getSuggestedOfferMappingsWith:businessId
    getSuggestedOfferMappingsRequest:getSuggestedOfferMappingsRequest
              completionHandler: ^(GetSuggestedOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getSuggestedOfferMappingsRequest':  // {GetSuggestedOfferMappingsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappings(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingsRequest = new GetSuggestedOfferMappingsRequest(); // GetSuggestedOfferMappingsRequest |  (optional) 

            try {
                // Просмотр карточек на Маркете, которые подходят вашим товарам
                GetSuggestedOfferMappingsResponse result = apiInstance.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getSuggestedOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappings($businessId, $getSuggestedOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getSuggestedOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingsRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingsRequest->new(); # GetSuggestedOfferMappingsRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappings(businessId => $businessId, getSuggestedOfferMappingsRequest => $getSuggestedOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getSuggestedOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingsRequest =  # GetSuggestedOfferMappingsRequest |  (optional)

try:
    # Просмотр карточек на Маркете, которые подходят вашим товарам
    api_response = api_instance.get_suggested_offer_mappings(businessId, getSuggestedOfferMappingsRequest=getSuggestedOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getSuggestedOfferMappings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let getSuggestedOfferMappingsRequest = ; // GetSuggestedOfferMappingsRequest

    let mut context = FbyApi::Context::default();
    let result = client.getSuggestedOfferMappings(businessId, getSuggestedOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingsRequest

Responses


getSuggestedPrices

Цены для продвижения товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [отчет «Цены на рынке»](../../reference/reports/generatePricesReport.md). {% endnote %} {% note warning "" %} Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях. {% endnote %} Возвращает цены для продвижения товаров, которые вы размещаете на Маркете. Товары, для которых нужно получить цены, передаются в теле POST-запроса. Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене. Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения. Установить цены на товары можно с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md) или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете. Подробно об автоматическом управлении ценами рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/prices.html). |**⚙️ Лимит:** 100 000 товаров в час| |-|


/campaigns/{campaignId}/offer-prices/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions" \
 -d '{
  "offers" : [ {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SuggestPricesRequest suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

try {
    final result = await api_instance.getSuggestedPrices(campaignId, suggestPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedPrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SuggestPricesRequest *suggestPricesRequest = ; // 

// Цены для продвижения товаров
[apiInstance getSuggestedPricesWith:campaignId
    suggestPricesRequest:suggestPricesRequest
              completionHandler: ^(SuggestPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var suggestPricesRequest = ; // {SuggestPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedPrices(campaignId, suggestPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

            try {
                // Цены для продвижения товаров
                SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.getSuggestedPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$suggestPricesRequest = ; // SuggestPricesRequest | 

try {
    $result = $api_instance->getSuggestedPrices($campaignId, $suggestPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->getSuggestedPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $suggestPricesRequest = WWW::OPenAPIClient::Object::SuggestPricesRequest->new(); # SuggestPricesRequest | 

eval {
    my $result = $api_instance->getSuggestedPrices(campaignId => $campaignId, suggestPricesRequest => $suggestPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->getSuggestedPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
suggestPricesRequest =  # SuggestPricesRequest | 

try:
    # Цены для продвижения товаров
    api_response = api_instance.get_suggested_prices(campaignId, suggestPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->getSuggestedPrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let suggestPricesRequest = ; // SuggestPricesRequest

    let mut context = FbyApi::Context::default();
    let result = client.getSuggestedPrices(campaignId, suggestPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
suggestPricesRequest *

Responses


putBidsForBusiness

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} ![](../../_images/api-boost.png) {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/businesses/{businessId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForBusiness(businessId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForBusiness: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#putBidsForBusiness");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок
[apiInstance putBidsForBusinessWith:businessId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForBusiness(businessId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForBusinessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок
                EmptyApiResponse result = apiInstance.putBidsForBusiness(businessId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.putBidsForBusiness: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForBusiness($businessId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForBusiness(businessId => $businessId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->putBidsForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок
    api_response = api_instance.put_bids_for_business(businessId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->putBidsForBusiness: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = FbyApi::Context::default();
    let result = client.putBidsForBusiness(businessId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


putBidsForCampaign

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или [PUT businesses/{businessId}/bids](/reference/bids/putBidsForBusiness). Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре `bid`. Подробнее о том, как работает буст продаж, читайте в [Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/campaigns.html). {% note info "𝓠 Как посмотреть расходы на буст продаж?" %} 𝓐 Фактические расходы на буст указаны в отчете по заказам ([POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md)). Сумма содержится в поле `bidFee`. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|


/campaigns/{campaignId}/bids

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/bids" \
 -d '{
  "bids" : [ {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  }, {
    "sku" : "sku",
    "bid" : 570
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final PutSkuBidsRequest putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

try {
    final result = await api_instance.putBidsForCampaign(campaignId, putSkuBidsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBidsForCampaign: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        PutSkuBidsRequest putSkuBidsRequest = ; // PutSkuBidsRequest | 

        try {
            EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#putBidsForCampaign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
PutSkuBidsRequest *putSkuBidsRequest = ; // 

// Включение буста продаж и установка ставок для магазина
[apiInstance putBidsForCampaignWith:campaignId
    putSkuBidsRequest:putSkuBidsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var putSkuBidsRequest = ; // {PutSkuBidsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putBidsForCampaign(campaignId, putSkuBidsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class putBidsForCampaignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var putSkuBidsRequest = new PutSkuBidsRequest(); // PutSkuBidsRequest | 

            try {
                // Включение буста продаж и установка ставок для магазина
                EmptyApiResponse result = apiInstance.putBidsForCampaign(campaignId, putSkuBidsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.putBidsForCampaign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$putSkuBidsRequest = ; // PutSkuBidsRequest | 

try {
    $result = $api_instance->putBidsForCampaign($campaignId, $putSkuBidsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $putSkuBidsRequest = WWW::OPenAPIClient::Object::PutSkuBidsRequest->new(); # PutSkuBidsRequest | 

eval {
    my $result = $api_instance->putBidsForCampaign(campaignId => $campaignId, putSkuBidsRequest => $putSkuBidsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->putBidsForCampaign: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
putSkuBidsRequest =  # PutSkuBidsRequest | 

try:
    # Включение буста продаж и установка ставок для магазина
    api_response = api_instance.put_bids_for_campaign(campaignId, putSkuBidsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->putBidsForCampaign: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let putSkuBidsRequest = ; // PutSkuBidsRequest

    let mut context = FbyApi::Context::default();
    let result = client.putBidsForCampaign(campaignId, putSkuBidsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
putSkuBidsRequest *

description

Responses


refreshFeed

Сообщить, что прайс-лист обновился

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом `POST campaigns/{campaignId}/feeds/{feedId}/refresh`. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — `200 OK`. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.refreshFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshFeed: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Сообщить, что прайс-лист обновился
[apiInstance refreshFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class refreshFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Сообщить, что прайс-лист обновился
                EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.refreshFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->refreshFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->refreshFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->refreshFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Сообщить, что прайс-лист обновился
    api_response = api_instance.refresh_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->refreshFeed: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.refreshFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


searchRegionChildren

Информация о дочерних регионах

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}/children

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}/children?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchRegionChildren(regionId, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionChildren: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о дочерних регионах
[apiInstance searchRegionChildrenWith:regionId
    page:page
    pageSize:pageSize
              completionHandler: ^(GetRegionWithChildrenResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionChildren(regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionChildrenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о дочерних регионах
                GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.searchRegionChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchRegionChildren($regionId, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->searchRegionChildren: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchRegionChildren(regionId => $regionId, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->searchRegionChildren: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о дочерних регионах
    api_response = api_instance.search_region_children(regionId, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->searchRegionChildren: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let regionId = 789; // Long
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.searchRegionChildren(regionId, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionsById

Информация о регионе

Возвращает информацию о регионе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    final result = await api_instance.searchRegionsById(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsById: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

// Информация о регионе
[apiInstance searchRegionsByIdWith:regionId
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsById(regionId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

            try {
                // Информация о регионе
                GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.searchRegionsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    $result = $api_instance->searchRegionsById($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->searchRegionsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


eval {
    my $result = $api_instance->searchRegionsById(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->searchRegionsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

try:
    # Информация о регионе
    api_response = api_instance.search_regions_by_id(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->searchRegionsById: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let regionId = 789; // Long

    let mut context = FbyApi::Context::default();
    let result = client.searchRegionsById(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required

Responses


searchRegionsByName

Поиск регионов по их имени

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска. Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions?name=name_example&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchRegionsByName(name, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsByName: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
String *name = name_example; // Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Поиск регионов по их имени
[apiInstance searchRegionsByNameWith:name
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var name = name_example; // {String} Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsByName(name, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByNameExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var name = name_example;  // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Поиск регионов по их имени
                GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.searchRegionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchRegionsByName($name, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->searchRegionsByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $name = name_example; # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchRegionsByName(name => $name, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->searchRegionsByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
name = name_example # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Поиск регионов по их имени
    api_response = api_instance.search_regions_by_name(name, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->searchRegionsByName: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let name = name_example; // String
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = FbyApi::Context::default();
    let result = client.searchRegionsByName(name, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
name*
String
Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


sendFileToChat

Отправка файла в чат

Отправляет файл в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/file/send

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/file/send?chatId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final File file = new File(); // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    final result = await api_instance.sendFileToChat(businessId, chatId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendFileToChat: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        File file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

        try {
            EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#sendFileToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
File *file = BINARY_DATA_HERE; // Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

// Отправка файла в чат
[apiInstance sendFileToChatWith:businessId
    chatId:chatId
    file:file
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var file = BINARY_DATA_HERE; // {File} Содержимое файла. Максимальный размер файла — 5 Мбайт.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFileToChat(businessId, chatId, file, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendFileToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var file = BINARY_DATA_HERE;  // File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

            try {
                // Отправка файла в чат
                EmptyApiResponse result = apiInstance.sendFileToChat(businessId, chatId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.sendFileToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$file = BINARY_DATA_HERE; // File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $api_instance->sendFileToChat($businessId, $chatId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $file = BINARY_DATA_HERE; # File | Содержимое файла. Максимальный размер файла — 5 Мбайт.

eval {
    my $result = $api_instance->sendFileToChat(businessId => $businessId, chatId => $chatId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->sendFileToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
file = BINARY_DATA_HERE # File | Содержимое файла. Максимальный размер файла — 5 Мбайт. (default to null)

try:
    # Отправка файла в чат
    api_response = api_instance.send_file_to_chat(businessId, chatId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->sendFileToChat: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = FbyApi::Context::default();
    let result = client.sendFileToChat(businessId, chatId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Form parameters
Name Description
file*
File (binary)
Содержимое файла. Максимальный размер файла — 5 Мбайт.
Required
Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


sendMessageToChat

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/chats/message

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/chats/message?chatId=789" \
 -d '{
  "message" : "message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long chatId = new Long(); // Long | Идентификатор чата.
final SendMessageToChatRequest sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

try {
    final result = await api_instance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sendMessageToChat: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long chatId = 789; // Long | Идентификатор чата.
        SendMessageToChatRequest sendMessageToChatRequest = ; // SendMessageToChatRequest | 

        try {
            EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#sendMessageToChat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *chatId = 789; // Идентификатор чата. (default to null)
SendMessageToChatRequest *sendMessageToChatRequest = ; // 

// Отправка сообщения в чат
[apiInstance sendMessageToChatWith:businessId
    chatId:chatId
    sendMessageToChatRequest:sendMessageToChatRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var chatId = 789; // {Long} Идентификатор чата.
var sendMessageToChatRequest = ; // {SendMessageToChatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class sendMessageToChatExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var chatId = 789;  // Long | Идентификатор чата. (default to null)
            var sendMessageToChatRequest = new SendMessageToChatRequest(); // SendMessageToChatRequest | 

            try {
                // Отправка сообщения в чат
                EmptyApiResponse result = apiInstance.sendMessageToChat(businessId, chatId, sendMessageToChatRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.sendMessageToChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$chatId = 789; // Long | Идентификатор чата.
$sendMessageToChatRequest = ; // SendMessageToChatRequest | 

try {
    $result = $api_instance->sendMessageToChat($businessId, $chatId, $sendMessageToChatRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $chatId = 789; # Long | Идентификатор чата.
my $sendMessageToChatRequest = WWW::OPenAPIClient::Object::SendMessageToChatRequest->new(); # SendMessageToChatRequest | 

eval {
    my $result = $api_instance->sendMessageToChat(businessId => $businessId, chatId => $chatId, sendMessageToChatRequest => $sendMessageToChatRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->sendMessageToChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
chatId = 789 # Long | Идентификатор чата. (default to null)
sendMessageToChatRequest =  # SendMessageToChatRequest | 

try:
    # Отправка сообщения в чат
    api_response = api_instance.send_message_to_chat(businessId, chatId, sendMessageToChatRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->sendMessageToChat: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let chatId = 789; // Long
    let sendMessageToChatRequest = ; // SendMessageToChatRequest

    let mut context = FbyApi::Context::default();
    let result = client.sendMessageToChat(businessId, chatId, sendMessageToChatRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
sendMessageToChatRequest *

description

Query parameters
Name Description
chatId*
Long (int64)
Идентификатор чата.
Required

Responses


setFeedParams

Изменение параметров прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: `name` (название параметра) и `value` (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: `name` (название параметра) и `delete=true` (удалить значение). |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/params

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/params" \
 -d '{
  "parameters" : [ {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  }, {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final SetFeedParamsRequest setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

try {
    final result = await api_instance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setFeedParams: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
SetFeedParamsRequest *setFeedParamsRequest = ; // 

// Изменение параметров прайс-листа
[apiInstance setFeedParamsWith:campaignId
    feedId:feedId
    setFeedParamsRequest:setFeedParamsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var setFeedParamsRequest = ; // {SetFeedParamsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFeedParams(campaignId, feedId, setFeedParamsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setFeedParamsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

            try {
                // Изменение параметров прайс-листа
                EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.setFeedParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$setFeedParamsRequest = ; // SetFeedParamsRequest | 

try {
    $result = $api_instance->setFeedParams($campaignId, $feedId, $setFeedParamsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $setFeedParamsRequest = WWW::OPenAPIClient::Object::SetFeedParamsRequest->new(); # SetFeedParamsRequest | 

eval {
    my $result = $api_instance->setFeedParams(campaignId => $campaignId, feedId => $feedId, setFeedParamsRequest => $setFeedParamsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->setFeedParams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
setFeedParamsRequest =  # SetFeedParamsRequest | 

try:
    # Изменение параметров прайс-листа
    api_response = api_instance.set_feed_params(campaignId, feedId, setFeedParamsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->setFeedParams: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let setFeedParamsRequest = ; // SetFeedParamsRequest

    let mut context = FbyApi::Context::default();
    let result = client.setFeedParams(campaignId, feedId, setFeedParamsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Body parameters
Name Description
setFeedParamsRequest *

Responses


skipGoodsFeedbacksReaction

Отказ от ответа на отзывы

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов [POST businesses/{businessId}/goods-feedback](../../reference/goods-feedback/getGoodsFeedbacks.md). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/skip-reaction

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/skip-reaction" \
 -d '{
  "feedbackIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

try {
    final result = await api_instance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->skipGoodsFeedbacksReaction: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SkipGoodsFeedbackReactionRequest *skipGoodsFeedbackReactionRequest = ; // 

// Отказ от ответа на отзывы
[apiInstance skipGoodsFeedbacksReactionWith:businessId
    skipGoodsFeedbackReactionRequest:skipGoodsFeedbackReactionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var skipGoodsFeedbackReactionRequest = ; // {SkipGoodsFeedbackReactionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class skipGoodsFeedbacksReactionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

            try {
                // Отказ от ответа на отзывы
                EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.skipGoodsFeedbacksReaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

try {
    $result = $api_instance->skipGoodsFeedbacksReaction($businessId, $skipGoodsFeedbackReactionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->skipGoodsFeedbacksReaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $skipGoodsFeedbackReactionRequest = WWW::OPenAPIClient::Object::SkipGoodsFeedbackReactionRequest->new(); # SkipGoodsFeedbackReactionRequest | 

eval {
    my $result = $api_instance->skipGoodsFeedbacksReaction(businessId => $businessId, skipGoodsFeedbackReactionRequest => $skipGoodsFeedbackReactionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->skipGoodsFeedbacksReaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
skipGoodsFeedbackReactionRequest =  # SkipGoodsFeedbackReactionRequest | 

try:
    # Отказ от ответа на отзывы
    api_response = api_instance.skip_goods_feedbacks_reaction(businessId, skipGoodsFeedbackReactionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->skipGoodsFeedbacksReaction: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest

    let mut context = FbyApi::Context::default();
    let result = client.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
skipGoodsFeedbackReactionRequest *

Responses


updateBusinessPrices

Установка цен на товары во всех магазинах

Устанавливает [базовые цены](*default-price). Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateBusinessPricesRequest updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

try {
    final result = await api_instance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateBusinessPrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateBusinessPricesRequest *updateBusinessPricesRequest = ; // 

// Установка цен на товары во всех магазинах
[apiInstance updateBusinessPricesWith:businessId
    updateBusinessPricesRequest:updateBusinessPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateBusinessPricesRequest = ; // {UpdateBusinessPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBusinessPrices(businessId, updateBusinessPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

            try {
                // Установка цен на товары во всех магазинах
                EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

try {
    $result = $api_instance->updateBusinessPrices($businessId, $updateBusinessPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateBusinessPricesRequest = WWW::OPenAPIClient::Object::UpdateBusinessPricesRequest->new(); # UpdateBusinessPricesRequest | 

eval {
    my $result = $api_instance->updateBusinessPrices(businessId => $businessId, updateBusinessPricesRequest => $updateBusinessPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateBusinessPricesRequest =  # UpdateBusinessPricesRequest | 

try:
    # Установка цен на товары во всех магазинах
    api_response = api_instance.update_business_prices(businessId, updateBusinessPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateBusinessPrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateBusinessPrices(businessId, updateBusinessPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateBusinessPricesRequest *

Responses


updateCampaignOffers

Изменение условий продажи товаров в магазине

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/update" \
 -d '{
  "offers" : [ {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateCampaignOffersRequest updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

try {
    final result = await api_instance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCampaignOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateCampaignOffersRequest *updateCampaignOffersRequest = ; // 

// Изменение условий продажи товаров в магазине
[apiInstance updateCampaignOffersWith:campaignId
    updateCampaignOffersRequest:updateCampaignOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateCampaignOffersRequest = ; // {UpdateCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCampaignOffers(campaignId, updateCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

            try {
                // Изменение условий продажи товаров в магазине
                EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

try {
    $result = $api_instance->updateCampaignOffers($campaignId, $updateCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateCampaignOffersRequest = WWW::OPenAPIClient::Object::UpdateCampaignOffersRequest->new(); # UpdateCampaignOffersRequest | 

eval {
    my $result = $api_instance->updateCampaignOffers(campaignId => $campaignId, updateCampaignOffersRequest => $updateCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateCampaignOffersRequest =  # UpdateCampaignOffersRequest | 

try:
    # Изменение условий продажи товаров в магазине
    api_response = api_instance.update_campaign_offers(campaignId, updateCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateCampaignOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateCampaignOffers(campaignId, updateCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateCampaignOffersRequest *

Responses


updateGoodsFeedbackComment

Добавление нового или изменение созданного комментария

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее. Для создания комментария к отзыву передайте только идентификатор отзыва `feedbackId`. Чтобы добавить комментарий к другому комментарию, передайте: * `feedbackId` — идентификатор отзыва; * `comment.parentId` — идентификатор родительского комментария. Чтобы изменить комментарий, передайте: * `feedbackId`— идентификатор отзыва; * `comment.id` — идентификатор комментария, который нужно изменить. Если передать одновременно `comment.parentId` и `comment.id`, будет изменен существующий комментарий. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/update" \
 -d '{
  "feedbackId" : 0,
  "comment" : {
    "id" : 6,
    "text" : "text",
    "parentId" : 1
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateGoodsFeedbackCommentRequest *updateGoodsFeedbackCommentRequest = ; // 

// Добавление нового или изменение созданного комментария
[apiInstance updateGoodsFeedbackCommentWith:businessId
    updateGoodsFeedbackCommentRequest:updateGoodsFeedbackCommentRequest
              completionHandler: ^(UpdateGoodsFeedbackCommentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateGoodsFeedbackCommentRequest = ; // {UpdateGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

            try {
                // Добавление нового или изменение созданного комментария
                UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->updateGoodsFeedbackComment($businessId, $updateGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::UpdateGoodsFeedbackCommentRequest->new(); # UpdateGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->updateGoodsFeedbackComment(businessId => $businessId, updateGoodsFeedbackCommentRequest => $updateGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateGoodsFeedbackCommentRequest =  # UpdateGoodsFeedbackCommentRequest | 

try:
    # Добавление нового или изменение созданного комментария
    api_response = api_instance.update_goods_feedback_comment(businessId, updateGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateGoodsFeedbackComment: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateGoodsFeedbackCommentRequest *

Responses


updateOfferContent

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Чтобы удалить характеристики, которые заданы в параметрах с типом `string`, передайте пустое значение. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/businesses/{businessId}/offer-cards/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards/update" \
 -d '{
  "offersContent" : [ {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  }, {
    "offerId" : "offerId",
    "categoryId" : 0,
    "parameterValues" : [ {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    }, {
      "valueId" : 5,
      "parameterId" : 1,
      "unitId" : 5,
      "value" : "value"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferContentRequest updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

try {
    final result = await api_instance.updateOfferContent(businessId, updateOfferContentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferContent: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferContentRequest updateOfferContentRequest = ; // UpdateOfferContentRequest | 

        try {
            UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferContentRequest *updateOfferContentRequest = ; // 

// Редактирование категорийных характеристик товара
[apiInstance updateOfferContentWith:businessId
    updateOfferContentRequest:updateOfferContentRequest
              completionHandler: ^(UpdateOfferContentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferContentRequest = ; // {UpdateOfferContentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferContent(businessId, updateOfferContentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferContentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferContentRequest = new UpdateOfferContentRequest(); // UpdateOfferContentRequest | 

            try {
                // Редактирование категорийных характеристик товара
                UpdateOfferContentResponse result = apiInstance.updateOfferContent(businessId, updateOfferContentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateOfferContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferContentRequest = ; // UpdateOfferContentRequest | 

try {
    $result = $api_instance->updateOfferContent($businessId, $updateOfferContentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferContentRequest = WWW::OPenAPIClient::Object::UpdateOfferContentRequest->new(); # UpdateOfferContentRequest | 

eval {
    my $result = $api_instance->updateOfferContent(businessId => $businessId, updateOfferContentRequest => $updateOfferContentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateOfferContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferContentRequest =  # UpdateOfferContentRequest | 

try:
    # Редактирование категорийных характеристик товара
    api_response = api_instance.update_offer_content(businessId, updateOfferContentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateOfferContent: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferContentRequest = ; // UpdateOfferContentRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateOfferContent(businessId, updateOfferContentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferContentRequest *

Responses


updateOfferMappingEntries

Добавление и редактирование товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре `shopSku` ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре `shopSku` ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/suggestions](../../reference/offer-mappings/getSuggestedOfferMappingEntries.md) или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус `NEED_CONTENT` (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус `NEED_INFO` (в описании товара не хватает информации) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5 000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-mapping-entries/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/updates" \
 -d '{
  "offerMappingEntries" : [ {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

try {
    final result = await api_instance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingEntryRequest *updateOfferMappingEntryRequest = ; // 

// Добавление и редактирование товаров в каталоге
[apiInstance updateOfferMappingEntriesWith:campaignId
    updateOfferMappingEntryRequest:updateOfferMappingEntryRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingEntryRequest = ; // {UpdateOfferMappingEntryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

            try {
                // Добавление и редактирование товаров в каталоге
                EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

try {
    $result = $api_instance->updateOfferMappingEntries($campaignId, $updateOfferMappingEntryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingEntryRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingEntryRequest->new(); # UpdateOfferMappingEntryRequest | 

eval {
    my $result = $api_instance->updateOfferMappingEntries(campaignId => $campaignId, updateOfferMappingEntryRequest => $updateOfferMappingEntryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingEntryRequest =  # UpdateOfferMappingEntryRequest | 

try:
    # Добавление и редактирование товаров в каталоге
    api_response = api_instance.update_offer_mapping_entries(campaignId, updateOfferMappingEntryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateOfferMappingEntries: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingEntryRequest *

Responses


updateOfferMappings

Добавление товаров в каталог и изменение информации о них

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах. Список категорий Маркета можно получить с помощью запроса [POST categories/tree](../../reference/categories/getCategoriesTree.md), а характеристики товаров по категориям с помощью [POST category/{categoryId}/parameters](../../reference/content/getCategoryContentParameters.md). Чтобы **добавить новый товар**, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (**SKU на Маркете**) в поле `marketSKU`. Для **новых товаров** обязательно укажите параметры: `offerId`, `name`, `marketCategoryId` или `category`, `pictures`, `vendor`, `description`. Чтобы **отредактировать информацию о товаре**, передайте новые данные, указав в `offerId` соответствующий **ваш SKU**. Поля, в которых ничего не меняется, можно не передавать. Чтобы **удалить характеристики**, которые заданы в параметрах с типом `string`, передайте пустое значение. Параметр `offerId` должен быть **уникальным** для всех товаров, которые вы передаете. {% note warning "Правила использования SKU" %} * У каждого товара SKU должен быть свой. * SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. * Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-mappings/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update" \
 -d '{
  "offerMappings" : [ {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  }, {
    "offer" : {
      "downloadable" : true,
      "marketCategoryId" : 0,
      "manufacturerCountries" : [ "Россия", "Россия" ],
      "description" : "description",
      "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
      "purchasePrice" : {
        "value" : 0.9301444243932576
      },
      "type" : "DEFAULT",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "vendor" : "LEVENHUK",
      "basicPrice" : {
        "discountBase" : 0.7061401241503109,
        "currencyId" : "RUR",
        "value" : 0.23021358869347652
      },
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "cofinancePrice" : {
        "value" : 0.9301444243932576
      },
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ],
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "params" : [ {
        "name" : "Wi-Fi",
        "value" : "есть"
      }, {
        "name" : "Wi-Fi",
        "value" : "есть"
      } ],
      "tags" : [ "до 500 рублей", "до 500 рублей" ],
      "condition" : {
        "reason" : "reason",
        "type" : "PREOWNED",
        "quality" : "PERFECT"
      },
      "certificates" : [ "certificates", "certificates" ],
      "boxCount" : 6,
      "additionalExpenses" : {
        "value" : 0.9301444243932576
      },
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "offerId" : "offerId",
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "customsCommodityCode" : "8517610008",
      "adult" : true,
      "age" : {
        "ageUnit" : "YEAR",
        "value" : 0.5962133916683182
      },
      "manuals" : [ {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      }, {
        "title" : "title",
        "url" : "url"
      } ]
    },
    "mapping" : {
      "marketSku" : 3
    }
  } ],
  "onlyPartnerMediaContent" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingsRequest updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

try {
    final result = await api_instance.updateOfferMappings(businessId, updateOfferMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappings: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingsRequest updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

        try {
            UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updateOfferMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingsRequest *updateOfferMappingsRequest = ; // 

// Добавление товаров в каталог и изменение информации о них
[apiInstance updateOfferMappingsWith:businessId
    updateOfferMappingsRequest:updateOfferMappingsRequest
              completionHandler: ^(UpdateOfferMappingsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingsRequest = ; // {UpdateOfferMappingsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappings(businessId, updateOfferMappingsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingsRequest = new UpdateOfferMappingsRequest(); // UpdateOfferMappingsRequest | 

            try {
                // Добавление товаров в каталог и изменение информации о них
                UpdateOfferMappingsResponse result = apiInstance.updateOfferMappings(businessId, updateOfferMappingsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updateOfferMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest | 

try {
    $result = $api_instance->updateOfferMappings($businessId, $updateOfferMappingsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updateOfferMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingsRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingsRequest->new(); # UpdateOfferMappingsRequest | 

eval {
    my $result = $api_instance->updateOfferMappings(businessId => $businessId, updateOfferMappingsRequest => $updateOfferMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updateOfferMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingsRequest =  # UpdateOfferMappingsRequest | 

try:
    # Добавление товаров в каталог и изменение информации о них
    api_response = api_instance.update_offer_mappings(businessId, updateOfferMappingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updateOfferMappings: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let updateOfferMappingsRequest = ; // UpdateOfferMappingsRequest

    let mut context = FbyApi::Context::default();
    let result = client.updateOfferMappings(businessId, updateOfferMappingsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingsRequest *

Responses


updatePrices

Установка цен на товары в конкретном магазине

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для управления базовыми ценами используйте [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updatePrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePricesRequest updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

try {
    final result = await api_instance.updatePrices(campaignId, updatePricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePrices: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updatePrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePricesRequest *updatePricesRequest = ; // 

// Установка цен на товары в конкретном магазине
[apiInstance updatePricesWith:campaignId
    updatePricesRequest:updatePricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePricesRequest = ; // {UpdatePricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePrices(campaignId, updatePricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

            try {
                // Установка цен на товары в конкретном магазине
                EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updatePrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePricesRequest = ; // UpdatePricesRequest | 

try {
    $result = $api_instance->updatePrices($campaignId, $updatePricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updatePrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePricesRequest = WWW::OPenAPIClient::Object::UpdatePricesRequest->new(); # UpdatePricesRequest | 

eval {
    my $result = $api_instance->updatePrices(campaignId => $campaignId, updatePricesRequest => $updatePricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updatePrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePricesRequest =  # UpdatePricesRequest | 

try:
    # Установка цен на товары в конкретном магазине
    api_response = api_instance.update_prices(campaignId, updatePricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updatePrices: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let campaignId = 789; // Long
    let updatePricesRequest = ; // UpdatePricesRequest

    let mut context = FbyApi::Context::default();
    let result = client.updatePrices(campaignId, updatePricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePricesRequest *

Responses


updatePromoOffers

Добавление товаров в акцию или изменение их цен

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/update" \
 -d '{
  "offers" : [ {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  } ],
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FbyApi;

import java.io.File;
import java.util.*;

public class FbyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePromoOffersRequest updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

try {
    final result = await api_instance.updatePromoOffers(businessId, updatePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePromoOffers: $e\n');
}

import org.openapitools.client.api.FbyApi;

public class FbyApiExample {
    public static void main(String[] args) {
        FbyApi apiInstance = new FbyApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FbyApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FbyApi *apiInstance = [[FbyApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePromoOffersRequest *updatePromoOffersRequest = ; // 

// Добавление товаров в акцию или изменение их цен
[apiInstance updatePromoOffersWith:businessId
    updatePromoOffersRequest:updatePromoOffersRequest
              completionHandler: ^(UpdatePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FbyApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePromoOffersRequest = ; // {UpdatePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePromoOffers(businessId, updatePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FbyApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

            try {
                // Добавление товаров в акцию или изменение их цен
                UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FbyApi.updatePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FbyApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

try {
    $result = $api_instance->updatePromoOffers($businessId, $updatePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FbyApi->updatePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FbyApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FbyApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePromoOffersRequest = WWW::OPenAPIClient::Object::UpdatePromoOffersRequest->new(); # UpdatePromoOffersRequest | 

eval {
    my $result = $api_instance->updatePromoOffers(businessId => $businessId, updatePromoOffersRequest => $updatePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FbyApi->updatePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FbyApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePromoOffersRequest =  # UpdatePromoOffersRequest | 

try:
    # Добавление товаров в акцию или изменение их цен
    api_response = api_instance.update_promo_offers(businessId, updatePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FbyApi->updatePromoOffers: %s\n" % e)
extern crate FbyApi;

pub fn main() {
    let businessId = 789; // Long
    let updatePromoOffersRequest = ; // UpdatePromoOffersRequest

    let mut context = FbyApi::Context::default();
    let result = client.updatePromoOffers(businessId, updatePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePromoOffersRequest *

Responses


Feedbacks

getFeedbackAndCommentUpdates

Новые и обновленные отзывы о магазине

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает новые и обновленные отзывы о магазине на Маркете. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/feedback/updates

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feedback/updates?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&from_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedbacksApi;

import java.io.File;
import java.util.*;

public class FeedbacksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedbacksApi apiInstance = new FeedbacksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedbacksApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final date fromDate = new date(); // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    final result = await api_instance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedbackAndCommentUpdates: $e\n');
}

import org.openapitools.client.api.FeedbacksApi;

public class FeedbacksApiExample {
    public static void main(String[] args) {
        FeedbacksApi apiInstance = new FeedbacksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        date fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


        try {
            GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedbacksApi#getFeedbackAndCommentUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedbacksApi *apiInstance = [[FeedbacksApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
date *fromDate = 2013-10-20; // Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

// Новые и обновленные отзывы о магазине
[apiInstance getFeedbackAndCommentUpdatesWith:campaignId
    pageToken:pageToken
    limit:limit
    fromDate:fromDate
              completionHandler: ^(GetFeedbackListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedbacksApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'fromDate': 2013-10-20 // {date} Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedbackAndCommentUpdates(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedbackAndCommentUpdatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedbacksApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var fromDate = 2013-10-20;  // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)

            try {
                // Новые и обновленные отзывы о магазине
                GetFeedbackListResponse result = apiInstance.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedbacksApi.getFeedbackAndCommentUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedbacksApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$fromDate = 2013-10-20; // date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


try {
    $result = $api_instance->getFeedbackAndCommentUpdates($campaignId, $pageToken, $limit, $fromDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedbacksApi->getFeedbackAndCommentUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedbacksApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedbacksApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $fromDate = 2013-10-20; # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.


eval {
    my $result = $api_instance->getFeedbackAndCommentUpdates(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, fromDate => $fromDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedbacksApi->getFeedbackAndCommentUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedbacksApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
fromDate = 2013-10-20 # date | Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: `ГГГГ-ММ-ДД`.
 (optional) (default to null)

try:
    # Новые и обновленные отзывы о магазине
    api_response = api_instance.get_feedback_and_comment_updates(campaignId, pageToken=pageToken, limit=limit, fromDate=fromDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedbacksApi->getFeedbackAndCommentUpdates: %s\n" % e)
extern crate FeedbacksApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let fromDate = 2013-10-20; // date

    let mut context = FeedbacksApi::Context::default();
    let result = client.getFeedbackAndCommentUpdates(campaignId, pageToken, limit, fromDate, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
from_date
date (date)
Начальная дата обновления отзывов. Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты. Формат даты: `ГГГГ-ММ-ДД`.

Responses


Feeds

getFeed

Информация о прайс-листе

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.getFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeed: $e\n');
}

import org.openapitools.client.api.FeedsApi;

public class FeedsApiExample {
    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedsApi *apiInstance = [[FeedsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Информация о прайс-листе
[apiInstance getFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(GetFeedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Информация о прайс-листе
                GetFeedResponse result = apiInstance.getFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedsApi.getFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->getFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->getFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->getFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Информация о прайс-листе
    api_response = api_instance.get_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->getFeed: %s\n" % e)
extern crate FeedsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FeedsApi::Context::default();
    let result = client.getFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


getFeedIndexLogs

Отчет по индексации прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра `generationId`. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/campaigns/{campaignId}/feeds/{feedId}/index-logs

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs?limit=20&published_time_from=2013-10-20T19:20:30+01:00&published_time_to=2013-10-20T19:20:30+01:00&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Date publishedTimeFrom = new Date(); // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

final Date publishedTimeTo = new Date(); // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

final FeedIndexLogsStatusType status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    final result = await api_instance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeedIndexLogs: $e\n');
}

import org.openapitools.client.api.FeedsApi;

public class FeedsApiExample {
    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer limit = 20; // Integer | Количество значений на одной странице.

        Date publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

        Date publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

        FeedIndexLogsStatusType status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


        try {
            GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeedIndexLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedsApi *apiInstance = [[FeedsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Date *publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
Date *publishedTimeTo = 2013-10-20T19:20:30+01:00; // Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
FeedIndexLogsStatusType *status = ; // Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

// Отчет по индексации прайс-листа
[apiInstance getFeedIndexLogsWith:campaignId
    feedId:feedId
    limit:limit
    publishedTimeFrom:publishedTimeFrom
    publishedTimeTo:publishedTimeTo
    status:status
              completionHandler: ^(GetFeedIndexLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var opts = {
  'limit': 20, // {Integer} Количество значений на одной странице.

  'publishedTimeFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

  'publishedTimeTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

  'status':  // {FeedIndexLogsStatusType} Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeedIndexLogs(campaignId, feedId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedIndexLogsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var publishedTimeFrom = 2013-10-20T19:20:30+01:00;  // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional)  (default to null)
            var publishedTimeTo = 2013-10-20T19:20:30+01:00;  // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional)  (default to null)
            var status = new FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional)  (default to null)

            try {
                // Отчет по индексации прайс-листа
                GetFeedIndexLogsResponse result = apiInstance.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedsApi.getFeedIndexLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$limit = 20; // Integer | Количество значений на одной странице.

$publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

$publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

$status = ; // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


try {
    $result = $api_instance->getFeedIndexLogs($campaignId, $feedId, $limit, $publishedTimeFrom, $publishedTimeTo, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $limit = 20; # Integer | Количество значений на одной странице.

my $publishedTimeFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

my $publishedTimeTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}

my $status = ; # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.


eval {
    my $result = $api_instance->getFeedIndexLogs(campaignId => $campaignId, feedId => $feedId, limit => $limit, publishedTimeFrom => $publishedTimeFrom, publishedTimeTo => $publishedTimeTo, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->getFeedIndexLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
publishedTimeFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.

Значение по умолчанию: последние восемь дней со времени отправки запроса.
 (optional) (default to null)
publishedTimeTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.

{% endnote %}
 (optional) (default to null)
status =  # FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:
* `ERROR` — произошли ошибки.
* `OK` — обработан без ошибок.
* `WARNING` — наблюдались некритичные проблемы.
 (optional) (default to null)

try:
    # Отчет по индексации прайс-листа
    api_response = api_instance.get_feed_index_logs(campaignId, feedId, limit=limit, publishedTimeFrom=publishedTimeFrom, publishedTimeTo=publishedTimeTo, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->getFeedIndexLogs: %s\n" % e)
extern crate FeedsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let limit = 20; // Integer
    let publishedTimeFrom = 2013-10-20T19:20:30+01:00; // Date
    let publishedTimeTo = 2013-10-20T19:20:30+01:00; // Date
    let status = ; // FeedIndexLogsStatusType

    let mut context = FeedsApi::Context::default();
    let result = client.getFeedIndexLogs(campaignId, feedId, limit, publishedTimeFrom, publishedTimeTo, status, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Query parameters
Name Description
limit
Integer (int32)
Количество значений на одной странице.
published_time_from
Date (date-time)
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.
published_time_to
Date (date-time)
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}
status
FeedIndexLogsStatusType
Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

Responses


getFeeds

Список прайс-листов магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |**⚙️ Лимит:** 1000 запросов в час| |-|


/campaigns/{campaignId}/feeds

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getFeeds(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFeeds: $e\n');
}

import org.openapitools.client.api.FeedsApi;

public class FeedsApiExample {
    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetFeedsResponse result = apiInstance.getFeeds(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedsApi *apiInstance = [[FeedsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список прайс-листов магазина
[apiInstance getFeedsWith:campaignId
              completionHandler: ^(GetFeedsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFeedsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список прайс-листов магазина
                GetFeedsResponse result = apiInstance.getFeeds(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedsApi.getFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getFeeds($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getFeeds(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->getFeeds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список прайс-листов магазина
    api_response = api_instance.get_feeds(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->getFeeds: %s\n" % e)
extern crate FeedsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = FeedsApi::Context::default();
    let result = client.getFeeds(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


refreshFeed

Сообщить, что прайс-лист обновился

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом `POST campaigns/{campaignId}/feeds/{feedId}/refresh`. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — `200 OK`. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/refresh

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.

try {
    final result = await api_instance.refreshFeed(campaignId, feedId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshFeed: $e\n');
}

import org.openapitools.client.api.FeedsApi;

public class FeedsApiExample {
    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.

        try {
            EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#refreshFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedsApi *apiInstance = [[FeedsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)

// Сообщить, что прайс-лист обновился
[apiInstance refreshFeedWith:campaignId
    feedId:feedId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshFeed(campaignId, feedId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class refreshFeedExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)

            try {
                // Сообщить, что прайс-лист обновился
                EmptyApiResponse result = apiInstance.refreshFeed(campaignId, feedId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedsApi.refreshFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.

try {
    $result = $api_instance->refreshFeed($campaignId, $feedId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.

eval {
    my $result = $api_instance->refreshFeed(campaignId => $campaignId, feedId => $feedId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->refreshFeed: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)

try:
    # Сообщить, что прайс-лист обновился
    api_response = api_instance.refresh_feed(campaignId, feedId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->refreshFeed: %s\n" % e)
extern crate FeedsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long

    let mut context = FeedsApi::Context::default();
    let result = client.refreshFeed(campaignId, feedId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required

Responses


setFeedParams

Изменение параметров прайс-листа

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: `name` (название параметра) и `value` (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: `name` (название параметра) и `delete=true` (удалить значение). |**⚙️ Лимит:** 3 запроса в час для одного прайс-листа| |-|


/campaigns/{campaignId}/feeds/{feedId}/params

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/params" \
 -d '{
  "parameters" : [ {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  }, {
    "deleted" : true,
    "values" : [ 0, 0 ],
    "name" : "name"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final SetFeedParamsRequest setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

try {
    final result = await api_instance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setFeedParams: $e\n');
}

import org.openapitools.client.api.FeedsApi;

public class FeedsApiExample {
    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        SetFeedParamsRequest setFeedParamsRequest = ; // SetFeedParamsRequest | 

        try {
            EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#setFeedParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
FeedsApi *apiInstance = [[FeedsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (default to null)
SetFeedParamsRequest *setFeedParamsRequest = ; // 

// Изменение параметров прайс-листа
[apiInstance setFeedParamsWith:campaignId
    feedId:feedId
    setFeedParamsRequest:setFeedParamsRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.FeedsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var feedId = 789; // {Long} Идентификатор прайс-листа.
var setFeedParamsRequest = ; // {SetFeedParamsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFeedParams(campaignId, feedId, setFeedParamsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setFeedParamsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FeedsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (default to null)
            var setFeedParamsRequest = new SetFeedParamsRequest(); // SetFeedParamsRequest | 

            try {
                // Изменение параметров прайс-листа
                EmptyApiResponse result = apiInstance.setFeedParams(campaignId, feedId, setFeedParamsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FeedsApi.setFeedParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FeedsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$setFeedParamsRequest = ; // SetFeedParamsRequest | 

try {
    $result = $api_instance->setFeedParams($campaignId, $feedId, $setFeedParamsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FeedsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FeedsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $setFeedParamsRequest = WWW::OPenAPIClient::Object::SetFeedParamsRequest->new(); # SetFeedParamsRequest | 

eval {
    my $result = $api_instance->setFeedParams(campaignId => $campaignId, feedId => $feedId, setFeedParamsRequest => $setFeedParamsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->setFeedParams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FeedsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (default to null)
setFeedParamsRequest =  # SetFeedParamsRequest | 

try:
    # Изменение параметров прайс-листа
    api_response = api_instance.set_feed_params(campaignId, feedId, setFeedParamsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->setFeedParams: %s\n" % e)
extern crate FeedsApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let setFeedParamsRequest = ; // SetFeedParamsRequest

    let mut context = FeedsApi::Context::default();
    let result = client.setFeedParams(campaignId, feedId, setFeedParamsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
feedId*
Long (int64)
Идентификатор прайс-листа.
Required
Body parameters
Name Description
setFeedParamsRequest *

Responses


GoodsFeedback

deleteGoodsFeedbackComment

Удаление комментария к отзыву

Удаляет комментарий магазина. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/delete" \
 -d '{
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsFeedbackApi;

import java.io.File;
import java.util.*;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.GoodsFeedbackApi;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteGoodsFeedbackCommentRequest deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#deleteGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsFeedbackApi *apiInstance = [[GoodsFeedbackApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteGoodsFeedbackCommentRequest *deleteGoodsFeedbackCommentRequest = ; // 

// Удаление комментария к отзыву
[apiInstance deleteGoodsFeedbackCommentWith:businessId
    deleteGoodsFeedbackCommentRequest:deleteGoodsFeedbackCommentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsFeedbackApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteGoodsFeedbackCommentRequest = ; // {DeleteGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsFeedbackApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteGoodsFeedbackCommentRequest = new DeleteGoodsFeedbackCommentRequest(); // DeleteGoodsFeedbackCommentRequest | 

            try {
                // Удаление комментария к отзыву
                EmptyApiResponse result = apiInstance.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsFeedbackApi.deleteGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsFeedbackApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->deleteGoodsFeedbackComment($businessId, $deleteGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsFeedbackApi->deleteGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsFeedbackApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsFeedbackApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::DeleteGoodsFeedbackCommentRequest->new(); # DeleteGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->deleteGoodsFeedbackComment(businessId => $businessId, deleteGoodsFeedbackCommentRequest => $deleteGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsFeedbackApi->deleteGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsFeedbackApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteGoodsFeedbackCommentRequest =  # DeleteGoodsFeedbackCommentRequest | 

try:
    # Удаление комментария к отзыву
    api_response = api_instance.delete_goods_feedback_comment(businessId, deleteGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsFeedbackApi->deleteGoodsFeedbackComment: %s\n" % e)
extern crate GoodsFeedbackApi;

pub fn main() {
    let businessId = 789; // Long
    let deleteGoodsFeedbackCommentRequest = ; // DeleteGoodsFeedbackCommentRequest

    let mut context = GoodsFeedbackApi::Context::default();
    let result = client.deleteGoodsFeedbackComment(businessId, deleteGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteGoodsFeedbackCommentRequest *

Responses


getGoodsFeedbackComments

Получение комментариев к отзыву

Возвращает комментарии к отзыву. Результаты возвращаются постранично, одна страница содержит не более 20 комментариев. Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "feedbackId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsFeedbackApi;

import java.io.File;
import java.util.*;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbackComments: $e\n');
}

import org.openapitools.client.api.GoodsFeedbackApi;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsFeedbackCommentsRequest getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#getGoodsFeedbackComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsFeedbackApi *apiInstance = [[GoodsFeedbackApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsFeedbackCommentsRequest *getGoodsFeedbackCommentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение комментариев к отзыву
[apiInstance getGoodsFeedbackCommentsWith:businessId
    getGoodsFeedbackCommentsRequest:getGoodsFeedbackCommentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetGoodsFeedbackCommentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsFeedbackApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsFeedbackCommentsRequest = ; // {GetGoodsFeedbackCommentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbackCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsFeedbackApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsFeedbackCommentsRequest = new GetGoodsFeedbackCommentsRequest(); // GetGoodsFeedbackCommentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение комментариев к отзыву
                GetGoodsFeedbackCommentsResponse result = apiInstance.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsFeedbackApi.getGoodsFeedbackComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsFeedbackApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getGoodsFeedbackComments($businessId, $getGoodsFeedbackCommentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsFeedbackApi->getGoodsFeedbackComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsFeedbackApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsFeedbackApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsFeedbackCommentsRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackCommentsRequest->new(); # GetGoodsFeedbackCommentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getGoodsFeedbackComments(businessId => $businessId, getGoodsFeedbackCommentsRequest => $getGoodsFeedbackCommentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsFeedbackApi->getGoodsFeedbackComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsFeedbackApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsFeedbackCommentsRequest =  # GetGoodsFeedbackCommentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение комментариев к отзыву
    api_response = api_instance.get_goods_feedback_comments(businessId, getGoodsFeedbackCommentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsFeedbackApi->getGoodsFeedbackComments: %s\n" % e)
extern crate GoodsFeedbackApi;

pub fn main() {
    let businessId = 789; // Long
    let getGoodsFeedbackCommentsRequest = ; // GetGoodsFeedbackCommentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = GoodsFeedbackApi::Context::default();
    let result = client.getGoodsFeedbackComments(businessId, getGoodsFeedbackCommentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackCommentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getGoodsFeedbacks

Получение отзывов о товарах продавца

Возвращает все отзывы о товарах продавца по указанным фильтрам. Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в `page_token`, если вы получали его ранее. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "ratingValues" : [ 0, 0, 0, 0, 0 ],
  "modelIds" : [ 6, 6, 6, 6, 6 ],
  "paid" : true,
  "reactionStatus" : "ALL",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsFeedbackApi;

import java.io.File;
import java.util.*;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetGoodsFeedbackRequest getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest | 

try {
    final result = await api_instance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsFeedbacks: $e\n');
}

import org.openapitools.client.api.GoodsFeedbackApi;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetGoodsFeedbackRequest getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

        try {
            GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#getGoodsFeedbacks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsFeedbackApi *apiInstance = [[GoodsFeedbackApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetGoodsFeedbackRequest *getGoodsFeedbackRequest = ; //  (optional)

// Получение отзывов о товарах продавца
[apiInstance getGoodsFeedbacksWith:businessId
    pageToken:pageToken
    limit:limit
    getGoodsFeedbackRequest:getGoodsFeedbackRequest
              completionHandler: ^(GetGoodsFeedbackResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsFeedbackApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getGoodsFeedbackRequest':  // {GetGoodsFeedbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsFeedbacks(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsFeedbacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsFeedbackApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getGoodsFeedbackRequest = new GetGoodsFeedbackRequest(); // GetGoodsFeedbackRequest |  (optional) 

            try {
                // Получение отзывов о товарах продавца
                GetGoodsFeedbackResponse result = apiInstance.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsFeedbackApi.getGoodsFeedbacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsFeedbackApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest | 

try {
    $result = $api_instance->getGoodsFeedbacks($businessId, $pageToken, $limit, $getGoodsFeedbackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsFeedbackApi->getGoodsFeedbacks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsFeedbackApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsFeedbackApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GetGoodsFeedbackRequest->new(); # GetGoodsFeedbackRequest | 

eval {
    my $result = $api_instance->getGoodsFeedbacks(businessId => $businessId, pageToken => $pageToken, limit => $limit, getGoodsFeedbackRequest => $getGoodsFeedbackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsFeedbackApi->getGoodsFeedbacks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsFeedbackApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getGoodsFeedbackRequest =  # GetGoodsFeedbackRequest |  (optional)

try:
    # Получение отзывов о товарах продавца
    api_response = api_instance.get_goods_feedbacks(businessId, pageToken=pageToken, limit=limit, getGoodsFeedbackRequest=getGoodsFeedbackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsFeedbackApi->getGoodsFeedbacks: %s\n" % e)
extern crate GoodsFeedbackApi;

pub fn main() {
    let businessId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getGoodsFeedbackRequest = ; // GetGoodsFeedbackRequest

    let mut context = GoodsFeedbackApi::Context::default();
    let result = client.getGoodsFeedbacks(businessId, pageToken, limit, getGoodsFeedbackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsFeedbackRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


skipGoodsFeedbacksReaction

Отказ от ответа на отзывы

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов [POST businesses/{businessId}/goods-feedback](../../reference/goods-feedback/getGoodsFeedbacks.md). |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/skip-reaction

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/skip-reaction" \
 -d '{
  "feedbackIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsFeedbackApi;

import java.io.File;
import java.util.*;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

try {
    final result = await api_instance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->skipGoodsFeedbacksReaction: $e\n');
}

import org.openapitools.client.api.GoodsFeedbackApi;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SkipGoodsFeedbackReactionRequest skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

        try {
            EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#skipGoodsFeedbacksReaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsFeedbackApi *apiInstance = [[GoodsFeedbackApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SkipGoodsFeedbackReactionRequest *skipGoodsFeedbackReactionRequest = ; // 

// Отказ от ответа на отзывы
[apiInstance skipGoodsFeedbacksReactionWith:businessId
    skipGoodsFeedbackReactionRequest:skipGoodsFeedbackReactionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsFeedbackApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var skipGoodsFeedbackReactionRequest = ; // {SkipGoodsFeedbackReactionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class skipGoodsFeedbacksReactionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsFeedbackApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var skipGoodsFeedbackReactionRequest = new SkipGoodsFeedbackReactionRequest(); // SkipGoodsFeedbackReactionRequest | 

            try {
                // Отказ от ответа на отзывы
                EmptyApiResponse result = apiInstance.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsFeedbackApi.skipGoodsFeedbacksReaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsFeedbackApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest | 

try {
    $result = $api_instance->skipGoodsFeedbacksReaction($businessId, $skipGoodsFeedbackReactionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsFeedbackApi->skipGoodsFeedbacksReaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsFeedbackApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsFeedbackApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $skipGoodsFeedbackReactionRequest = WWW::OPenAPIClient::Object::SkipGoodsFeedbackReactionRequest->new(); # SkipGoodsFeedbackReactionRequest | 

eval {
    my $result = $api_instance->skipGoodsFeedbacksReaction(businessId => $businessId, skipGoodsFeedbackReactionRequest => $skipGoodsFeedbackReactionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsFeedbackApi->skipGoodsFeedbacksReaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsFeedbackApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
skipGoodsFeedbackReactionRequest =  # SkipGoodsFeedbackReactionRequest | 

try:
    # Отказ от ответа на отзывы
    api_response = api_instance.skip_goods_feedbacks_reaction(businessId, skipGoodsFeedbackReactionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsFeedbackApi->skipGoodsFeedbacksReaction: %s\n" % e)
extern crate GoodsFeedbackApi;

pub fn main() {
    let businessId = 789; // Long
    let skipGoodsFeedbackReactionRequest = ; // SkipGoodsFeedbackReactionRequest

    let mut context = GoodsFeedbackApi::Context::default();
    let result = client.skipGoodsFeedbacksReaction(businessId, skipGoodsFeedbackReactionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
skipGoodsFeedbackReactionRequest *

Responses


updateGoodsFeedbackComment

Добавление нового или изменение созданного комментария

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее. Для создания комментария к отзыву передайте только идентификатор отзыва `feedbackId`. Чтобы добавить комментарий к другому комментарию, передайте: * `feedbackId` — идентификатор отзыва; * `comment.parentId` — идентификатор родительского комментария. Чтобы изменить комментарий, передайте: * `feedbackId`— идентификатор отзыва; * `comment.id` — идентификатор комментария, который нужно изменить. Если передать одновременно `comment.parentId` и `comment.id`, будет изменен существующий комментарий. |**⚙️ Лимит:** 1 000 запросов в час| |-|


/businesses/{businessId}/goods-feedback/comments/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/goods-feedback/comments/update" \
 -d '{
  "feedbackId" : 0,
  "comment" : {
    "id" : 6,
    "text" : "text",
    "parentId" : 1
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsFeedbackApi;

import java.io.File;
import java.util.*;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

try {
    final result = await api_instance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGoodsFeedbackComment: $e\n');
}

import org.openapitools.client.api.GoodsFeedbackApi;

public class GoodsFeedbackApiExample {
    public static void main(String[] args) {
        GoodsFeedbackApi apiInstance = new GoodsFeedbackApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateGoodsFeedbackCommentRequest updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

        try {
            UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsFeedbackApi#updateGoodsFeedbackComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsFeedbackApi *apiInstance = [[GoodsFeedbackApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateGoodsFeedbackCommentRequest *updateGoodsFeedbackCommentRequest = ; // 

// Добавление нового или изменение созданного комментария
[apiInstance updateGoodsFeedbackCommentWith:businessId
    updateGoodsFeedbackCommentRequest:updateGoodsFeedbackCommentRequest
              completionHandler: ^(UpdateGoodsFeedbackCommentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsFeedbackApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateGoodsFeedbackCommentRequest = ; // {UpdateGoodsFeedbackCommentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateGoodsFeedbackCommentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsFeedbackApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateGoodsFeedbackCommentRequest = new UpdateGoodsFeedbackCommentRequest(); // UpdateGoodsFeedbackCommentRequest | 

            try {
                // Добавление нового или изменение созданного комментария
                UpdateGoodsFeedbackCommentResponse result = apiInstance.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsFeedbackApi.updateGoodsFeedbackComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsFeedbackApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest | 

try {
    $result = $api_instance->updateGoodsFeedbackComment($businessId, $updateGoodsFeedbackCommentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsFeedbackApi->updateGoodsFeedbackComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsFeedbackApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsFeedbackApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateGoodsFeedbackCommentRequest = WWW::OPenAPIClient::Object::UpdateGoodsFeedbackCommentRequest->new(); # UpdateGoodsFeedbackCommentRequest | 

eval {
    my $result = $api_instance->updateGoodsFeedbackComment(businessId => $businessId, updateGoodsFeedbackCommentRequest => $updateGoodsFeedbackCommentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsFeedbackApi->updateGoodsFeedbackComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsFeedbackApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateGoodsFeedbackCommentRequest =  # UpdateGoodsFeedbackCommentRequest | 

try:
    # Добавление нового или изменение созданного комментария
    api_response = api_instance.update_goods_feedback_comment(businessId, updateGoodsFeedbackCommentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsFeedbackApi->updateGoodsFeedbackComment: %s\n" % e)
extern crate GoodsFeedbackApi;

pub fn main() {
    let businessId = 789; // Long
    let updateGoodsFeedbackCommentRequest = ; // UpdateGoodsFeedbackCommentRequest

    let mut context = GoodsFeedbackApi::Context::default();
    let result = client.updateGoodsFeedbackComment(businessId, updateGoodsFeedbackCommentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateGoodsFeedbackCommentRequest *

Responses


GoodsStats

getGoodsStats

Отчет по товарам

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/stats/skus

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/skus" \
 -d '{
  "shopSkus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GoodsStatsApi;

import java.io.File;
import java.util.*;

public class GoodsStatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        GoodsStatsApi apiInstance = new GoodsStatsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsStatsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetGoodsStatsRequest getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

try {
    final result = await api_instance.getGoodsStats(campaignId, getGoodsStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGoodsStats: $e\n');
}

import org.openapitools.client.api.GoodsStatsApi;

public class GoodsStatsApiExample {
    public static void main(String[] args) {
        GoodsStatsApi apiInstance = new GoodsStatsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetGoodsStatsRequest getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

        try {
            GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsStatsApi#getGoodsStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
GoodsStatsApi *apiInstance = [[GoodsStatsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetGoodsStatsRequest *getGoodsStatsRequest = ; // 

// Отчет по товарам
[apiInstance getGoodsStatsWith:campaignId
    getGoodsStatsRequest:getGoodsStatsRequest
              completionHandler: ^(GetGoodsStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.GoodsStatsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getGoodsStatsRequest = ; // {GetGoodsStatsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGoodsStats(campaignId, getGoodsStatsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getGoodsStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new GoodsStatsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getGoodsStatsRequest = new GetGoodsStatsRequest(); // GetGoodsStatsRequest | 

            try {
                // Отчет по товарам
                GetGoodsStatsResponse result = apiInstance.getGoodsStats(campaignId, getGoodsStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GoodsStatsApi.getGoodsStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GoodsStatsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getGoodsStatsRequest = ; // GetGoodsStatsRequest | 

try {
    $result = $api_instance->getGoodsStats($campaignId, $getGoodsStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsStatsApi->getGoodsStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GoodsStatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GoodsStatsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getGoodsStatsRequest = WWW::OPenAPIClient::Object::GetGoodsStatsRequest->new(); # GetGoodsStatsRequest | 

eval {
    my $result = $api_instance->getGoodsStats(campaignId => $campaignId, getGoodsStatsRequest => $getGoodsStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoodsStatsApi->getGoodsStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.GoodsStatsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getGoodsStatsRequest =  # GetGoodsStatsRequest | 

try:
    # Отчет по товарам
    api_response = api_instance.get_goods_stats(campaignId, getGoodsStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoodsStatsApi->getGoodsStats: %s\n" % e)
extern crate GoodsStatsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getGoodsStatsRequest = ; // GetGoodsStatsRequest

    let mut context = GoodsStatsApi::Context::default();
    let result = client.getGoodsStats(campaignId, getGoodsStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getGoodsStatsRequest *

Responses


HiddenOffers

addHiddenOffers

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HiddenOffersApi;

import java.io.File;
import java.util.*;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final AddHiddenOffersRequest addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

try {
    final result = await api_instance.addHiddenOffers(campaignId, addHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addHiddenOffers: $e\n');
}

import org.openapitools.client.api.HiddenOffersApi;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        AddHiddenOffersRequest addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#addHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
HiddenOffersApi *apiInstance = [[HiddenOffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
AddHiddenOffersRequest *addHiddenOffersRequest = ; // 

// Скрытие товаров и настройки скрытия
[apiInstance addHiddenOffersWith:campaignId
    addHiddenOffersRequest:addHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.HiddenOffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var addHiddenOffersRequest = ; // {AddHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addHiddenOffers(campaignId, addHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class addHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new HiddenOffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var addHiddenOffersRequest = new AddHiddenOffersRequest(); // AddHiddenOffersRequest | 

            try {
                // Скрытие товаров и настройки скрытия
                EmptyApiResponse result = apiInstance.addHiddenOffers(campaignId, addHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HiddenOffersApi.addHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HiddenOffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$addHiddenOffersRequest = ; // AddHiddenOffersRequest | 

try {
    $result = $api_instance->addHiddenOffers($campaignId, $addHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HiddenOffersApi->addHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HiddenOffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HiddenOffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $addHiddenOffersRequest = WWW::OPenAPIClient::Object::AddHiddenOffersRequest->new(); # AddHiddenOffersRequest | 

eval {
    my $result = $api_instance->addHiddenOffers(campaignId => $campaignId, addHiddenOffersRequest => $addHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HiddenOffersApi->addHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.HiddenOffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
addHiddenOffersRequest =  # AddHiddenOffersRequest | 

try:
    # Скрытие товаров и настройки скрытия
    api_response = api_instance.add_hidden_offers(campaignId, addHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HiddenOffersApi->addHiddenOffers: %s\n" % e)
extern crate HiddenOffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let addHiddenOffersRequest = ; // AddHiddenOffersRequest

    let mut context = HiddenOffersApi::Context::default();
    let result = client.addHiddenOffers(campaignId, addHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
addHiddenOffersRequest *

Запрос на скрытие оферов.

Responses


deleteHiddenOffers

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/hidden-offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers/delete" \
 -d '{
  "hiddenOffers" : [ {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  }, {
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HiddenOffersApi;

import java.io.File;
import java.util.*;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteHiddenOffersRequest deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

try {
    final result = await api_instance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHiddenOffers: $e\n');
}

import org.openapitools.client.api.HiddenOffersApi;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteHiddenOffersRequest deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#deleteHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
HiddenOffersApi *apiInstance = [[HiddenOffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteHiddenOffersRequest *deleteHiddenOffersRequest = ; // 

// Возобновление показа товаров
[apiInstance deleteHiddenOffersWith:campaignId
    deleteHiddenOffersRequest:deleteHiddenOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.HiddenOffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteHiddenOffersRequest = ; // {DeleteHiddenOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new HiddenOffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteHiddenOffersRequest = new DeleteHiddenOffersRequest(); // DeleteHiddenOffersRequest | 

            try {
                // Возобновление показа товаров
                EmptyApiResponse result = apiInstance.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HiddenOffersApi.deleteHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HiddenOffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest | 

try {
    $result = $api_instance->deleteHiddenOffers($campaignId, $deleteHiddenOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HiddenOffersApi->deleteHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HiddenOffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HiddenOffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteHiddenOffersRequest = WWW::OPenAPIClient::Object::DeleteHiddenOffersRequest->new(); # DeleteHiddenOffersRequest | 

eval {
    my $result = $api_instance->deleteHiddenOffers(campaignId => $campaignId, deleteHiddenOffersRequest => $deleteHiddenOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HiddenOffersApi->deleteHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.HiddenOffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteHiddenOffersRequest =  # DeleteHiddenOffersRequest | 

try:
    # Возобновление показа товаров
    api_response = api_instance.delete_hidden_offers(campaignId, deleteHiddenOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HiddenOffersApi->deleteHiddenOffers: %s\n" % e)
extern crate HiddenOffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteHiddenOffersRequest = ; // DeleteHiddenOffersRequest

    let mut context = HiddenOffersApi::Context::default();
    let result = client.deleteHiddenOffers(campaignId, deleteHiddenOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteHiddenOffersRequest *

Запрос на возобновление показа оферов.

Responses


getHiddenOffers

Информация о скрытых вами товарах

Возвращает список скрытых вами товаров для заданного магазина. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/campaigns/{campaignId}/hidden-offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers?offer_id=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&offset=56&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HiddenOffersApi;

import java.io.File;
import java.util.*;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Integer offset = new Integer(); // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHiddenOffers: $e\n');
}

import org.openapitools.client.api.HiddenOffersApi;

public class HiddenOffersApiExample {
    public static void main(String[] args) {
        HiddenOffersApi apiInstance = new HiddenOffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор скрытого предложения.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Integer offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HiddenOffersApi#getHiddenOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
HiddenOffersApi *apiInstance = [[HiddenOffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор скрытого предложения.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Integer *offset = 56; // Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о скрытых вами товарах
[apiInstance getHiddenOffersWith:campaignId
    offerId:offerId
    pageToken:pageToken
    limit:limit
    offset:offset
    page:page
    pageSize:pageSize
              completionHandler: ^(GetHiddenOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.HiddenOffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор скрытого предложения.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'offset': 56, // {Integer} Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHiddenOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getHiddenOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new HiddenOffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор скрытого предложения.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var offset = 56;  // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о скрытых вами товарах
                GetHiddenOffersResponse result = apiInstance.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HiddenOffersApi.getHiddenOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HiddenOffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор скрытого предложения.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$offset = 56; // Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getHiddenOffers($campaignId, $offerId, $pageToken, $limit, $offset, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HiddenOffersApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HiddenOffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HiddenOffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор скрытого предложения.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $offset = 56; # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getHiddenOffers(campaignId => $campaignId, offerId => $offerId, pageToken => $pageToken, limit => $limit, offset => $offset, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HiddenOffersApi->getHiddenOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.HiddenOffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор скрытого предложения.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
offset = 56 # Integer | Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром `limit`.

Если задан `offset`, параметры `page_number` и `page_size` игнорируются.

`offset` игнорируется, если задан `page_token`.
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о скрытых вами товарах
    api_response = api_instance.get_hidden_offers(campaignId, offerId=offerId, pageToken=pageToken, limit=limit, offset=offset, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HiddenOffersApi->getHiddenOffers: %s\n" % e)
extern crate HiddenOffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let offset = 56; // Integer
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = HiddenOffersApi::Context::default();
    let result = client.getHiddenOffers(campaignId, offerId, pageToken, limit, offset, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор скрытого предложения.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
offset
Integer (int32)
Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


Models

getModel

Информация об одной модели

Возвращает информацию о модели товара. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/{modelId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models/{modelId}?regionId=789¤cy="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelsApi;

import java.io.File;
import java.util.*;

public class ModelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ModelsApi apiInstance = new ModelsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long modelId = new Long(); // Long | Идентификатор модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    final result = await api_instance.getModel(modelId, regionId, currency);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModel: $e\n');
}

import org.openapitools.client.api.ModelsApi;

public class ModelsApiExample {
    public static void main(String[] args) {
        ModelsApi apiInstance = new ModelsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ModelsApi *apiInstance = [[ModelsApi alloc] init];
Long *modelId = 789; // Идентификатор модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

// Информация об одной модели
[apiInstance getModelWith:modelId
    regionId:regionId
    currency:currency
              completionHandler: ^(GetModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ModelsApi()
var modelId = 789; // {Long} Идентификатор модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency':  // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModel(modelId, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ModelsApi();
            var modelId = 789;  // Long | Идентификатор модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)

            try {
                // Информация об одной модели
                GetModelsResponse result = apiInstance.getModel(modelId, regionId, currency);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelsApi.getModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelsApi();
$modelId = 789; // Long | Идентификатор модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    $result = $api_instance->getModel($modelId, $regionId, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelsApi->new();
my $modelId = 789; # Long | Идентификатор модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


eval {
    my $result = $api_instance->getModel(modelId => $modelId, regionId => $regionId, currency => $currency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelsApi->getModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ModelsApi()
modelId = 789 # Long | Идентификатор модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

try:
    # Информация об одной модели
    api_response = api_instance.get_model(modelId, regionId, currency=currency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelsApi->getModel: %s\n" % e)
extern crate ModelsApi;

pub fn main() {
    let modelId = 789; // Long
    let regionId = 789; // Long
    let currency = ; // CurrencyType

    let mut context = ModelsApi::Context::default();
    let result = client.getModel(modelId, regionId, currency, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
modelId*
Long (int64)
Идентификатор модели товара.
Required
Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

Responses


getModelOffers

Список предложений для одной модели

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется. Для методов `GET models/{modelId}/offers` и `POST models/offers` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/{modelId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models/{modelId}/offers?regionId=789¤cy=&orderByPrice=&count=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelsApi;

import java.io.File;
import java.util.*;

public class ModelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ModelsApi apiInstance = new ModelsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

        Integer count = 56; // Integer | Количество предложений на странице ответа.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModelOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long modelId = new Long(); // Long | Идентификатор модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final SortOrderType orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

final Integer count = new Integer(); // Integer | Количество предложений на странице ответа.
final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModelOffers: $e\n');
}

import org.openapitools.client.api.ModelsApi;

public class ModelsApiExample {
    public static void main(String[] args) {
        ModelsApi apiInstance = new ModelsApi();
        Long modelId = 789; // Long | Идентификатор модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

        Integer count = 56; // Integer | Количество предложений на странице ответа.
        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModelOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ModelsApi *apiInstance = [[ModelsApi alloc] init];
Long *modelId = 789; // Идентификатор модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
SortOrderType *orderByPrice = ; // Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)
Integer *count = 56; // Количество предложений на странице ответа. (optional) (default to 10)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)

// Список предложений для одной модели
[apiInstance getModelOffersWith:modelId
    regionId:regionId
    currency:currency
    orderByPrice:orderByPrice
    count:count
    page:page
              completionHandler: ^(GetModelsOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ModelsApi()
var modelId = 789; // {Long} Идентификатор модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'orderByPrice': , // {SortOrderType} Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

  'count': 56, // {Integer} Количество предложений на странице ответа.
  'page': 56 // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelOffers(modelId, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ModelsApi();
            var modelId = 789;  // Long | Идентификатор модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional)  (default to null)
            var count = 56;  // Integer | Количество предложений на странице ответа. (optional)  (default to 10)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)

            try {
                // Список предложений для одной модели
                GetModelsOffersResponse result = apiInstance.getModelOffers(modelId, regionId, currency, orderByPrice, count, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelsApi.getModelOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelsApi();
$modelId = 789; // Long | Идентификатор модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

$count = 56; // Integer | Количество предложений на странице ответа.
$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getModelOffers($modelId, $regionId, $currency, $orderByPrice, $count, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModelOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelsApi->new();
my $modelId = 789; # Long | Идентификатор модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $orderByPrice = ; # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

my $count = 56; # Integer | Количество предложений на странице ответа.
my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getModelOffers(modelId => $modelId, regionId => $regionId, currency => $currency, orderByPrice => $orderByPrice, count => $count, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelsApi->getModelOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ModelsApi()
modelId = 789 # Long | Идентификатор модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
orderByPrice =  # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)
count = 56 # Integer | Количество предложений на странице ответа. (optional) (default to 10)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)

try:
    # Список предложений для одной модели
    api_response = api_instance.get_model_offers(modelId, regionId, currency=currency, orderByPrice=orderByPrice, count=count, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelsApi->getModelOffers: %s\n" % e)
extern crate ModelsApi;

pub fn main() {
    let modelId = 789; // Long
    let regionId = 789; // Long
    let currency = ; // CurrencyType
    let orderByPrice = ; // SortOrderType
    let count = 56; // Integer
    let page = 56; // Integer

    let mut context = ModelsApi::Context::default();
    let result = client.getModelOffers(modelId, regionId, currency, orderByPrice, count, page, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
modelId*
Long (int64)
Идентификатор модели товара.
Required
Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
orderByPrice
SortOrderType
Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.
count
Integer (int32)
Количество предложений на странице ответа.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


getModels

Информация о нескольких моделях

Возвращает информацию о моделях товаров. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/models?regionId=789¤cy=" \
 -d '{
  "models" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelsApi;

import java.io.File;
import java.util.*;

public class ModelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ModelsApi apiInstance = new ModelsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final GetModelsRequest getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    final result = await api_instance.getModels(regionId, getModelsRequest, currency);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModels: $e\n');
}

import org.openapitools.client.api.ModelsApi;

public class ModelsApiExample {
    public static void main(String[] args) {
        ModelsApi apiInstance = new ModelsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


        try {
            GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ModelsApi *apiInstance = [[ModelsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
GetModelsRequest *getModelsRequest = ; // 
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

// Информация о нескольких моделях
[apiInstance getModelsWith:regionId
    getModelsRequest:getModelsRequest
    currency:currency
              completionHandler: ^(GetModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ModelsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var getModelsRequest = ; // {GetModelsRequest} 
var opts = {
  'currency':  // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModels(regionId, getModelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ModelsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)

            try {
                // Информация о нескольких моделях
                GetModelsResponse result = apiInstance.getModels(regionId, getModelsRequest, currency);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelsApi.getModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$getModelsRequest = ; // GetModelsRequest | 
$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


try {
    $result = $api_instance->getModels($regionId, $getModelsRequest, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $getModelsRequest = WWW::OPenAPIClient::Object::GetModelsRequest->new(); # GetModelsRequest | 
my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).


eval {
    my $result = $api_instance->getModels(regionId => $regionId, getModelsRequest => $getModelsRequest, currency => $currency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelsApi->getModels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ModelsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
getModelsRequest =  # GetModelsRequest | 
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)

try:
    # Информация о нескольких моделях
    api_response = api_instance.get_models(regionId, getModelsRequest, currency=currency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelsApi->getModels: %s\n" % e)
extern crate ModelsApi;

pub fn main() {
    let regionId = 789; // Long
    let getModelsRequest = ; // GetModelsRequest
    let currency = ; // CurrencyType

    let mut context = ModelsApi::Context::default();
    let result = client.getModels(regionId, getModelsRequest, currency, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getModelsRequest *

Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

Responses


getModelsOffers

Список предложений для нескольких моделей

Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются. В одном запросе можно получить информацию о предложениях не более чем для 100 моделей. Для методов `GET models/{modelId}/offers` и `POST models/offers` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/models/offers?regionId=789¤cy=&orderByPrice=" \
 -d '{
  "models" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelsApi;

import java.io.File;
import java.util.*;

public class ModelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ModelsApi apiInstance = new ModelsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


        try {
            GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModelsOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final GetModelsRequest getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final SortOrderType orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


try {
    final result = await api_instance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getModelsOffers: $e\n');
}

import org.openapitools.client.api.ModelsApi;

public class ModelsApiExample {
    public static void main(String[] args) {
        ModelsApi apiInstance = new ModelsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        GetModelsRequest getModelsRequest = ; // GetModelsRequest | 
        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        SortOrderType orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


        try {
            GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#getModelsOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ModelsApi *apiInstance = [[ModelsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
GetModelsRequest *getModelsRequest = ; // 
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
SortOrderType *orderByPrice = ; // Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)

// Список предложений для нескольких моделей
[apiInstance getModelsOffersWith:regionId
    getModelsRequest:getModelsRequest
    currency:currency
    orderByPrice:orderByPrice
              completionHandler: ^(GetModelsOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ModelsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var getModelsRequest = ; // {GetModelsRequest} 
var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'orderByPrice':  // {SortOrderType} Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelsOffers(regionId, getModelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getModelsOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ModelsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var getModelsRequest = new GetModelsRequest(); // GetModelsRequest | 
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var orderByPrice = new SortOrderType(); // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional)  (default to null)

            try {
                // Список предложений для нескольких моделей
                GetModelsOffersResponse result = apiInstance.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelsApi.getModelsOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$getModelsRequest = ; // GetModelsRequest | 
$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$orderByPrice = ; // SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


try {
    $result = $api_instance->getModelsOffers($regionId, $getModelsRequest, $currency, $orderByPrice);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModelsOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $getModelsRequest = WWW::OPenAPIClient::Object::GetModelsRequest->new(); # GetModelsRequest | 
my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $orderByPrice = ; # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.


eval {
    my $result = $api_instance->getModelsOffers(regionId => $regionId, getModelsRequest => $getModelsRequest, currency => $currency, orderByPrice => $orderByPrice);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelsApi->getModelsOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ModelsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
getModelsRequest =  # GetModelsRequest | 
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
orderByPrice =  # SortOrderType | Направление сортировки по цене.

Возможные значения:
* `ASC` — сортировка по возрастанию.
* `DESC` — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.
 (optional) (default to null)

try:
    # Список предложений для нескольких моделей
    api_response = api_instance.get_models_offers(regionId, getModelsRequest, currency=currency, orderByPrice=orderByPrice)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelsApi->getModelsOffers: %s\n" % e)
extern crate ModelsApi;

pub fn main() {
    let regionId = 789; // Long
    let getModelsRequest = ; // GetModelsRequest
    let currency = ; // CurrencyType
    let orderByPrice = ; // SortOrderType

    let mut context = ModelsApi::Context::default();
    let result = client.getModelsOffers(regionId, getModelsRequest, currency, orderByPrice, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
getModelsRequest *

Query parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
orderByPrice
SortOrderType
Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.

Responses


searchModels

Поиск модели товара

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов `GET models`, `GET models/{modelId}` и `POST models` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |**⚙️ Лимит:** [рассчитывается индивидуально](*rule)| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)


/models

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/models?query=query_example®ionId=789¤cy=&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelsApi;

import java.io.File;
import java.util.*;

public class ModelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ModelsApi apiInstance = new ModelsApi();
        String query = query_example; // String | Поисковый запрос по названию модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#searchModels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | Поисковый запрос по названию модели товара.
final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchModels(query, regionId, currency, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchModels: $e\n');
}

import org.openapitools.client.api.ModelsApi;

public class ModelsApiExample {
    public static void main(String[] args) {
        ModelsApi apiInstance = new ModelsApi();
        String query = query_example; // String | Поисковый запрос по названию модели товара.
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        CurrencyType currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelsApi#searchModels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ModelsApi *apiInstance = [[ModelsApi alloc] init];
String *query = query_example; // Поисковый запрос по названию модели товара. (default to null)
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
CurrencyType *currency = ; // Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Поиск модели товара
[apiInstance searchModelsWith:query
    regionId:regionId
    currency:currency
    page:page
    pageSize:pageSize
              completionHandler: ^(SearchModelsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ModelsApi()
var query = query_example; // {String} Поисковый запрос по названию модели товара.
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'currency': , // {CurrencyType} Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchModels(query, regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchModelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ModelsApi();
            var query = query_example;  // String | Поисковый запрос по названию модели товара. (default to null)
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Поиск модели товара
                SearchModelsResponse result = apiInstance.searchModels(query, regionId, currency, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelsApi.searchModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelsApi();
$query = query_example; // String | Поисковый запрос по названию модели товара.
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$currency = ; // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchModels($query, $regionId, $currency, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->searchModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelsApi->new();
my $query = query_example; # String | Поисковый запрос по названию модели товара.
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $currency = ; # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchModels(query => $query, regionId => $regionId, currency => $currency, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelsApi->searchModels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ModelsApi()
query = query_example # String | Поисковый запрос по названию модели товара. (default to null)
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
currency =  # CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Поиск модели товара
    api_response = api_instance.search_models(query, regionId, currency=currency, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelsApi->searchModels: %s\n" % e)
extern crate ModelsApi;

pub fn main() {
    let query = query_example; // String
    let regionId = 789; // Long
    let currency = ; // CurrencyType
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = ModelsApi::Context::default();
    let result = client.searchModels(query, regionId, currency, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
query*
String
Поисковый запрос по названию модели товара.
Required
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
currency
CurrencyType
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


OfferMappings

getOfferMappingEntries

Список товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров в каталоге магазина * 25)


/campaigns/{campaignId}/offer-mapping-entries

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries?offer_id=&shop_sku=&mapping_kind=&status=&availability=&category_id=&vendor=&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OfferMappingsApi;

import java.io.File;
import java.util.*;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[String] offerId = new array[String](); // array[String] | Идентификатор товара в каталоге.
final array[String] shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final OfferMappingKindType mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
final array[OfferProcessingStatusType] status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final array[OfferAvailabilityStatusType] availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[Integer] categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

final array[String] vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.OfferMappingsApi;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[String] offerId = ; // array[String] | Идентификатор товара в каталоге.
        array[String] shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        OfferMappingKindType mappingKind = ; // OfferMappingKindType | Тип маппинга.
        array[OfferProcessingStatusType] status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        array[OfferAvailabilityStatusType] availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[Integer] categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

        array[String] vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#getOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OfferMappingsApi *apiInstance = [[OfferMappingsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[String] *offerId = ; // Идентификатор товара в каталоге. (optional) (default to null)
array[String] *shopSku = ; // Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
OfferMappingKindType *mappingKind = ; // Тип маппинга. (optional) (default to null)
array[OfferProcessingStatusType] *status = ; // Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[OfferAvailabilityStatusType] *availability = ; // Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[Integer] *categoryId = ; // Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
array[String] *vendor = ; // Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров в каталоге
[apiInstance getOfferMappingEntriesWith:campaignId
    offerId:offerId
    shopSku:shopSku
    mappingKind:mappingKind
    status:status
    availability:availability
    categoryId:categoryId
    vendor:vendor
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OfferMappingsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'offerId': , // {array[String]} Идентификатор товара в каталоге.
  'shopSku': , // {array[String]} Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'mappingKind': , // {OfferMappingKindType} Тип маппинга.
  'status': , // {array[OfferProcessingStatusType]} Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'availability': , // {array[OfferAvailabilityStatusType]} Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'categoryId': , // {array[Integer]} Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

  'vendor': , // {array[String]} Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferMappingEntries(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OfferMappingsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var offerId = new array[String](); // array[String] | Идентификатор товара в каталоге. (optional)  (default to null)
            var shopSku = new array[String](); // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var mappingKind = new OfferMappingKindType(); // OfferMappingKindType | Тип маппинга. (optional)  (default to null)
            var status = new array[OfferProcessingStatusType](); // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var availability = new array[OfferAvailabilityStatusType](); // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var categoryId = new array[Integer](); // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var vendor = new array[String](); // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional)  (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров в каталоге
                GetOfferMappingEntriesResponse result = apiInstance.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OfferMappingsApi.getOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OfferMappingsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$offerId = ; // array[String] | Идентификатор товара в каталоге.
$shopSku = ; // array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$mappingKind = ; // OfferMappingKindType | Тип маппинга.
$status = ; // array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$availability = ; // array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$categoryId = ; // array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

$vendor = ; // array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferMappingEntries($campaignId, $offerId, $shopSku, $mappingKind, $status, $availability, $categoryId, $vendor, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OfferMappingsApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OfferMappingsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $offerId = []; # array[String] | Идентификатор товара в каталоге.
my $shopSku = []; # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $mappingKind = ; # OfferMappingKindType | Тип маппинга.
my $status = []; # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $availability = []; # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $categoryId = []; # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.

my $vendor = []; # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferMappingEntries(campaignId => $campaignId, offerId => $offerId, shopSku => $shopSku, mappingKind => $mappingKind, status => $status, availability => $availability, categoryId => $categoryId, vendor => $vendor, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OfferMappingsApi->getOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OfferMappingsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
offerId =  # array[String] | Идентификатор товара в каталоге. (optional) (default to null)
shopSku =  # array[String] | Ваш SKU товара.

Параметр может быть указан несколько раз, например:

```
...shop_sku=123&shop_sku=129&shop_sku=141...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
mappingKind =  # OfferMappingKindType | Тип маппинга. (optional) (default to null)
status =  # array[OfferProcessingStatusType] | Фильтрация по статусу публикации товара:

* `READY` — товар прошел модерацию.
* `IN_WORK` — товар проходит модерацию.
* `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
* `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
* `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
* `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
* `OTHER` — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
```

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
availability =  # array[OfferAvailabilityStatusType] | Фильтрация по планам поставок товара:

* `ACTIVE` — поставки будут.
* `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
* `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
categoryId =  # array[Integer] | Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md).

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
```

В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
vendor =  # array[String] | Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

```
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
```

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
 (optional) (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров в каталоге
    api_response = api_instance.get_offer_mapping_entries(campaignId, offerId=offerId, shopSku=shopSku, mappingKind=mappingKind, status=status, availability=availability, categoryId=categoryId, vendor=vendor, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OfferMappingsApi->getOfferMappingEntries: %s\n" % e)
extern crate OfferMappingsApi;

pub fn main() {
    let campaignId = 789; // Long
    let offerId = ; // array[String]
    let shopSku = ; // array[String]
    let mappingKind = ; // OfferMappingKindType
    let status = ; // array[OfferProcessingStatusType]
    let availability = ; // array[OfferAvailabilityStatusType]
    let categoryId = ; // array[Integer]
    let vendor = ; // array[String]
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = OfferMappingsApi::Context::default();
    let result = client.getOfferMappingEntries(campaignId, offerId, shopSku, mappingKind, status, availability, categoryId, vendor, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
offer_id
array[String]
Идентификатор товара в каталоге.
shop_sku
array[String]
Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
mapping_kind
OfferMappingKindType
Тип маппинга.
status
array[OfferProcessingStatusType]
Фильтрация по статусу публикации товара: * `READY` — товар прошел модерацию. * `IN_WORK` — товар проходит модерацию. * `NEED_CONTENT` — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * `NEED_INFO` — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * `REJECTED` — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * `SUSPENDED` — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * `OTHER` — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
availability
array[OfferAvailabilityStatusType]
Фильтрация по планам поставок товара: * `ACTIVE` — поставки будут. * `INACTIVE` — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * `DELISTED` — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
category_id
array[Integer]
Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом [POST categories/tree](../../reference/categories/getCategoriesTree.md). Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
vendor
array[String]
Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL). В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedOfferMappingEntries

Рекомендованные карточки для товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/suggestions](../../reference/business-assortment/getSuggestedOfferMappings.md). {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/updates](../../reference/offer-mappings/updateOfferMappingEntries.md). В одном запросе можно получить не более 500 рекомендаций. |**⚙️ Лимит:** 100 000 рекомендаций в час| |-|


/campaigns/{campaignId}/offer-mapping-entries/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions" \
 -d '{
  "offers" : [ {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  }, {
    "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
    "certificate" : "certificate",
    "description" : "description",
    "availability" : "ACTIVE",
    "pictures" : [ "pictures", "pictures" ],
    "vendorCode" : "VNDR-0005A",
    "manufacturer" : "manufacturer",
    "urls" : [ "urls", "urls" ],
    "deliveryDurationDays" : 5,
    "feedId" : 0,
    "vendor" : "LEVENHUK",
    "price" : 2.027123023002322,
    "transportUnitSize" : 1,
    "id" : "id",
    "lifeTime" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "shelfLife" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
    "lifeTimeDays" : 9,
    "quantumOfSupply" : 5,
    "barcodes" : [ "46012300000000", "46012300000000" ],
    "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
    "processingState" : {
      "notes" : [ {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      }, {
        "payload" : "payload",
        "type" : "ASSORTMENT"
      } ],
      "status" : "UNKNOWN"
    },
    "shopSku" : "shopSku",
    "boxCount" : 2,
    "minShipment" : 6,
    "name" : "Ударная дрель Makita HP1630, 710 Вт",
    "shelfLifeDays" : 7,
    "guaranteePeriod" : {
      "timePeriod" : 6,
      "comment" : "comment",
      "timeUnit" : "HOUR"
    },
    "weightDimensions" : {
      "length" : 65.55,
      "width" : 50.7,
      "weight" : 1.001,
      "height" : 20
    },
    "category" : "category",
    "guaranteePeriodDays" : 3
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OfferMappingsApi;

import java.io.File;
import java.util.*;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

try {
    final result = await api_instance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.OfferMappingsApi;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetSuggestedOfferMappingEntriesRequest getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

        try {
            GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#getSuggestedOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OfferMappingsApi *apiInstance = [[OfferMappingsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetSuggestedOfferMappingEntriesRequest *getSuggestedOfferMappingEntriesRequest = ; // 

// Рекомендованные карточки для товаров
[apiInstance getSuggestedOfferMappingEntriesWith:campaignId
    getSuggestedOfferMappingEntriesRequest:getSuggestedOfferMappingEntriesRequest
              completionHandler: ^(GetSuggestedOfferMappingEntriesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OfferMappingsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getSuggestedOfferMappingEntriesRequest = ; // {GetSuggestedOfferMappingEntriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OfferMappingsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getSuggestedOfferMappingEntriesRequest = new GetSuggestedOfferMappingEntriesRequest(); // GetSuggestedOfferMappingEntriesRequest | 

            try {
                // Рекомендованные карточки для товаров
                GetSuggestedOfferMappingEntriesResponse result = apiInstance.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OfferMappingsApi.getSuggestedOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OfferMappingsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest | 

try {
    $result = $api_instance->getSuggestedOfferMappingEntries($campaignId, $getSuggestedOfferMappingEntriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OfferMappingsApi->getSuggestedOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OfferMappingsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getSuggestedOfferMappingEntriesRequest = WWW::OPenAPIClient::Object::GetSuggestedOfferMappingEntriesRequest->new(); # GetSuggestedOfferMappingEntriesRequest | 

eval {
    my $result = $api_instance->getSuggestedOfferMappingEntries(campaignId => $campaignId, getSuggestedOfferMappingEntriesRequest => $getSuggestedOfferMappingEntriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OfferMappingsApi->getSuggestedOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OfferMappingsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getSuggestedOfferMappingEntriesRequest =  # GetSuggestedOfferMappingEntriesRequest | 

try:
    # Рекомендованные карточки для товаров
    api_response = api_instance.get_suggested_offer_mapping_entries(campaignId, getSuggestedOfferMappingEntriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OfferMappingsApi->getSuggestedOfferMappingEntries: %s\n" % e)
extern crate OfferMappingsApi;

pub fn main() {
    let campaignId = 789; // Long
    let getSuggestedOfferMappingEntriesRequest = ; // GetSuggestedOfferMappingEntriesRequest

    let mut context = OfferMappingsApi::Context::default();
    let result = client.getSuggestedOfferMappingEntries(campaignId, getSuggestedOfferMappingEntriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getSuggestedOfferMappingEntriesRequest *

Responses


updateOfferMappingEntries

Добавление и редактирование товаров в каталоге

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST businesses/{businessId}/offer-mappings/update](../../reference/business-assortment/updateOfferMappings.md). {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре `shopSku` ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре `shopSku` ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса [POST campaigns/{campaignId}/offer-mapping-entries/suggestions](../../reference/offer-mappings/getSuggestedOfferMappingEntries.md) или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус `NEED_CONTENT` (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус `NEED_INFO` (в описании товара не хватает информации) в выходных данных запроса [GET campaigns/{campaignId}/offer-mapping-entries](../../reference/offer-mappings/getOfferMappingEntries.md). В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5 000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-mapping-entries/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/updates" \
 -d '{
  "offerMappingEntries" : [ {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  }, {
    "offer" : {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    },
    "mapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "awaitingModerationMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    },
    "rejectedMapping" : {
      "modelId" : 7,
      "marketSku" : 4,
      "categoryId" : 1
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OfferMappingsApi;

import java.io.File;
import java.util.*;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

try {
    final result = await api_instance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOfferMappingEntries: $e\n');
}

import org.openapitools.client.api.OfferMappingsApi;

public class OfferMappingsApiExample {
    public static void main(String[] args) {
        OfferMappingsApi apiInstance = new OfferMappingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOfferMappingEntryRequest updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OfferMappingsApi#updateOfferMappingEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OfferMappingsApi *apiInstance = [[OfferMappingsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOfferMappingEntryRequest *updateOfferMappingEntryRequest = ; // 

// Добавление и редактирование товаров в каталоге
[apiInstance updateOfferMappingEntriesWith:campaignId
    updateOfferMappingEntryRequest:updateOfferMappingEntryRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OfferMappingsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOfferMappingEntryRequest = ; // {UpdateOfferMappingEntryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOfferMappingEntriesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OfferMappingsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOfferMappingEntryRequest = new UpdateOfferMappingEntryRequest(); // UpdateOfferMappingEntryRequest | 

            try {
                // Добавление и редактирование товаров в каталоге
                EmptyApiResponse result = apiInstance.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OfferMappingsApi.updateOfferMappingEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OfferMappingsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest | 

try {
    $result = $api_instance->updateOfferMappingEntries($campaignId, $updateOfferMappingEntryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OfferMappingsApi->updateOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OfferMappingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OfferMappingsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOfferMappingEntryRequest = WWW::OPenAPIClient::Object::UpdateOfferMappingEntryRequest->new(); # UpdateOfferMappingEntryRequest | 

eval {
    my $result = $api_instance->updateOfferMappingEntries(campaignId => $campaignId, updateOfferMappingEntryRequest => $updateOfferMappingEntryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OfferMappingsApi->updateOfferMappingEntries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OfferMappingsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOfferMappingEntryRequest =  # UpdateOfferMappingEntryRequest | 

try:
    # Добавление и редактирование товаров в каталоге
    api_response = api_instance.update_offer_mapping_entries(campaignId, updateOfferMappingEntryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OfferMappingsApi->updateOfferMappingEntries: %s\n" % e)
extern crate OfferMappingsApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOfferMappingEntryRequest = ; // UpdateOfferMappingEntryRequest

    let mut context = OfferMappingsApi::Context::default();
    let result = client.updateOfferMappingEntries(campaignId, updateOfferMappingEntryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOfferMappingEntryRequest *

Responses


Offers

deleteCampaignOffers

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/delete" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeleteCampaignOffersRequest deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

try {
    final result = await api_instance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteCampaignOffers: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeleteCampaignOffersRequest deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

        try {
            DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#deleteCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeleteCampaignOffersRequest *deleteCampaignOffersRequest = ; // 

// Удаление товаров из ассортимента магазина
[apiInstance deleteCampaignOffersWith:campaignId
    deleteCampaignOffersRequest:deleteCampaignOffersRequest
              completionHandler: ^(DeleteCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deleteCampaignOffersRequest = ; // {DeleteCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deleteCampaignOffersRequest = new DeleteCampaignOffersRequest(); // DeleteCampaignOffersRequest | 

            try {
                // Удаление товаров из ассортимента магазина
                DeleteCampaignOffersResponse result = apiInstance.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.deleteCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest | 

try {
    $result = $api_instance->deleteCampaignOffers($campaignId, $deleteCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->deleteCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deleteCampaignOffersRequest = WWW::OPenAPIClient::Object::DeleteCampaignOffersRequest->new(); # DeleteCampaignOffersRequest | 

eval {
    my $result = $api_instance->deleteCampaignOffers(campaignId => $campaignId, deleteCampaignOffersRequest => $deleteCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->deleteCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deleteCampaignOffersRequest =  # DeleteCampaignOffersRequest | 

try:
    # Удаление товаров из ассортимента магазина
    api_response = api_instance.delete_campaign_offers(campaignId, deleteCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->deleteCampaignOffers: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let deleteCampaignOffersRequest = ; // DeleteCampaignOffersRequest

    let mut context = OffersApi::Context::default();
    let result = client.deleteCampaignOffers(campaignId, deleteCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deleteCampaignOffersRequest *

Responses


getAllOffers

Все предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers/all

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/all?feedId=789&chunk=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final Integer chunk = new Integer(); // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    final result = await api_instance.getAllOffers(campaignId, feedId, chunk);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOffers: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        Integer chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


        try {
            GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAllOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
Integer *chunk = 56; // Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

// Все предложения магазина
[apiInstance getAllOffersWith:campaignId
    feedId:feedId
    chunk:chunk
              completionHandler: ^(GetAllOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'chunk': 56 // {Integer} Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getAllOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var chunk = 56;  // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional)  (default to null)

            try {
                // Все предложения магазина
                GetAllOffersResponse result = apiInstance.getAllOffers(campaignId, feedId, chunk);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.getAllOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$feedId = 789; // Long | Идентификатор прайс-листа.
$chunk = 56; // Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


try {
    $result = $api_instance->getAllOffers($campaignId, $feedId, $chunk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getAllOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $chunk = 56; # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}


eval {
    my $result = $api_instance->getAllOffers(campaignId => $campaignId, feedId => $feedId, chunk => $chunk);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getAllOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
chunk = 56 # Integer | Номер сегмента с результатами.

Значение по умолчанию: `0`.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.

{% endnote %}
 (optional) (default to null)

try:
    # Все предложения магазина
    api_response = api_instance.get_all_offers(campaignId, feedId=feedId, chunk=chunk)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getAllOffers: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let feedId = 789; // Long
    let chunk = 56; // Integer

    let mut context = OffersApi::Context::default();
    let result = client.getAllOffers(campaignId, feedId, chunk, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
feedId
Long (int64)
Идентификатор прайс-листа.
chunk
Integer (int32)
Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}

Responses


getCampaignOffers

Информация о товарах, которые размещены в заданном магазине

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "statuses" : [ "PUBLISHED", "PUBLISHED" ],
  "offerIds" : [ null, null, null, null, null ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetCampaignOffersRequest getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignOffers: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetCampaignOffersRequest getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetCampaignOffersRequest *getCampaignOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Информация о товарах, которые размещены в заданном магазине
[apiInstance getCampaignOffersWith:campaignId
    getCampaignOffersRequest:getCampaignOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetCampaignOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getCampaignOffersRequest = ; // {GetCampaignOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignOffers(campaignId, getCampaignOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getCampaignOffersRequest = new GetCampaignOffersRequest(); // GetCampaignOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Информация о товарах, которые размещены в заданном магазине
                GetCampaignOffersResponse result = apiInstance.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.getCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getCampaignOffersRequest = ; // GetCampaignOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignOffers($campaignId, $getCampaignOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getCampaignOffersRequest = WWW::OPenAPIClient::Object::GetCampaignOffersRequest->new(); # GetCampaignOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignOffers(campaignId => $campaignId, getCampaignOffersRequest => $getCampaignOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getCampaignOffersRequest =  # GetCampaignOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Информация о товарах, которые размещены в заданном магазине
    api_response = api_instance.get_campaign_offers(campaignId, getCampaignOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getCampaignOffers: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let getCampaignOffersRequest = ; // GetCampaignOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = OffersApi::Context::default();
    let result = client.getCampaignOffers(campaignId, getCampaignOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getCampaignOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOfferRecommendations

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. **1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.** Показывает, какие **цены для участия** нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#sponsored-discounts) **2. Оценка привлекательности цен на витрине.** Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. [Как это устроено](https://yandex.ru/support/marketplace/marketing/smart-pricing.html#validation) В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/offers/recommendations

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cofinancePriceFilter" : "SPECIFIED",
  "competitivenessFilter" : "OPTIMAL",
  "offerIds" : [ null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetOfferRecommendationsRequest getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOfferRecommendations: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetOfferRecommendationsRequest getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOfferRecommendations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetOfferRecommendationsRequest *getOfferRecommendationsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Рекомендации Маркета, касающиеся цен
[apiInstance getOfferRecommendationsWith:businessId
    getOfferRecommendationsRequest:getOfferRecommendationsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetOfferRecommendationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getOfferRecommendationsRequest = ; // {GetOfferRecommendationsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfferRecommendations(businessId, getOfferRecommendationsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOfferRecommendationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getOfferRecommendationsRequest = new GetOfferRecommendationsRequest(); // GetOfferRecommendationsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Рекомендации Маркета, касающиеся цен
                GetOfferRecommendationsResponse result = apiInstance.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.getOfferRecommendations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getOfferRecommendations($businessId, $getOfferRecommendationsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getOfferRecommendationsRequest = WWW::OPenAPIClient::Object::GetOfferRecommendationsRequest->new(); # GetOfferRecommendationsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getOfferRecommendations(businessId => $businessId, getOfferRecommendationsRequest => $getOfferRecommendationsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getOfferRecommendations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getOfferRecommendationsRequest =  # GetOfferRecommendationsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Рекомендации Маркета, касающиеся цен
    api_response = api_instance.get_offer_recommendations(businessId, getOfferRecommendationsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getOfferRecommendations: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let businessId = 789; // Long
    let getOfferRecommendationsRequest = ; // GetOfferRecommendationsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = OffersApi::Context::default();
    let result = client.getOfferRecommendations(businessId, getOfferRecommendationsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOfferRecommendationsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getOffers

Предложения магазина

{% note warning "" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)


/campaigns/{campaignId}/offers

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers?query=query_example&feedId=789&shopCategoryId=shopCategoryId_example¤cy=&matched=true&page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String query = new String(); // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

final Long feedId = new Long(); // Long | Идентификатор прайс-листа.
final String shopCategoryId = new String(); // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

final CurrencyType currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

final Boolean matched = new Boolean(); // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOffers: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

        Long feedId = 789; // Long | Идентификатор прайс-листа.
        String shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

        CurrencyType currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

        Boolean matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *query = query_example; // Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
Long *feedId = 789; // Идентификатор прайс-листа. (optional) (default to null)
String *shopCategoryId = shopCategoryId_example; // Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
CurrencyType *currency = ; // Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
Boolean *matched = true; // Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Предложения магазина
[apiInstance getOffersWith:campaignId
    query:query
    feedId:feedId
    shopCategoryId:shopCategoryId
    currency:currency
    matched:matched
    page:page
    pageSize:pageSize
              completionHandler: ^(GetOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'query': query_example, // {String} Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

  'feedId': 789, // {Long} Идентификатор прайс-листа.
  'shopCategoryId': shopCategoryId_example, // {String} Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

  'currency': , // {CurrencyType} Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

  'matched': true, // {Boolean} Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var query = query_example;  // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional)  (default to null)
            var feedId = 789;  // Long | Идентификатор прайс-листа. (optional)  (default to null)
            var shopCategoryId = shopCategoryId_example;  // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional)  (default to null)
            var currency = new CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional)  (default to null)
            var matched = true;  // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional)  (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Предложения магазина
                GetOffersResponse result = apiInstance.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$query = query_example; // String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

$feedId = 789; // Long | Идентификатор прайс-листа.
$shopCategoryId = shopCategoryId_example; // String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

$currency = ; // CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

$matched = true; // Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->getOffers($campaignId, $query, $feedId, $shopCategoryId, $currency, $matched, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $query = query_example; # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

my $feedId = 789; # Long | Идентификатор прайс-листа.
my $shopCategoryId = shopCategoryId_example; # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

my $currency = ; # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.

my $matched = true; # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->getOffers(campaignId => $campaignId, query => $query, feedId => $feedId, shopCategoryId => $shopCategoryId, currency => $currency, matched => $matched, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
query = query_example # String | Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.
 (optional) (default to null)
feedId = 789 # Long | Идентификатор прайс-листа. (optional) (default to null)
shopCategoryId = shopCategoryId_example # String | Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.
 (optional) (default to null)
currency =  # CurrencyType | Валюта, в которой указана цена предложения.

Возможные значения:

* `BYN` — белорусский рубль.

* `KZT` — казахстанский тенге.

* `RUR` — российский рубль.

* `UAH` — украинская гривна.
 (optional) (default to null)
matched = true # Boolean | Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

* `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

* `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
 (optional) (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Предложения магазина
    api_response = api_instance.get_offers(campaignId, query=query, feedId=feedId, shopCategoryId=shopCategoryId, currency=currency, matched=matched, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getOffers: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let query = query_example; // String
    let feedId = 789; // Long
    let shopCategoryId = shopCategoryId_example; // String
    let currency = ; // CurrencyType
    let matched = true; // Boolean
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = OffersApi::Context::default();
    let result = client.getOffers(campaignId, query, feedId, shopCategoryId, currency, matched, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
query
String
Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId
Long (int64)
Идентификатор прайс-листа.
shopCategoryId
String
Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency
CurrencyType
Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.
matched
Boolean
Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


updateCampaignOffers

Изменение условий продажи товаров в магазине

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/update" \
 -d '{
  "offers" : [ {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  }, {
    "available" : true,
    "vat" : 0,
    "offerId" : "offerId",
    "quantum" : {
      "minQuantity" : 1,
      "stepQuantity" : 60
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateCampaignOffersRequest updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

try {
    final result = await api_instance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCampaignOffers: $e\n');
}

import org.openapitools.client.api.OffersApi;

public class OffersApiExample {
    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateCampaignOffersRequest updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#updateCampaignOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OffersApi *apiInstance = [[OffersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateCampaignOffersRequest *updateCampaignOffersRequest = ; // 

// Изменение условий продажи товаров в магазине
[apiInstance updateCampaignOffersWith:campaignId
    updateCampaignOffersRequest:updateCampaignOffersRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OffersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateCampaignOffersRequest = ; // {UpdateCampaignOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCampaignOffers(campaignId, updateCampaignOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateCampaignOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OffersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateCampaignOffersRequest = new UpdateCampaignOffersRequest(); // UpdateCampaignOffersRequest | 

            try {
                // Изменение условий продажи товаров в магазине
                EmptyApiResponse result = apiInstance.updateCampaignOffers(campaignId, updateCampaignOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OffersApi.updateCampaignOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OffersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest | 

try {
    $result = $api_instance->updateCampaignOffers($campaignId, $updateCampaignOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->updateCampaignOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OffersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OffersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateCampaignOffersRequest = WWW::OPenAPIClient::Object::UpdateCampaignOffersRequest->new(); # UpdateCampaignOffersRequest | 

eval {
    my $result = $api_instance->updateCampaignOffers(campaignId => $campaignId, updateCampaignOffersRequest => $updateCampaignOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->updateCampaignOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OffersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateCampaignOffersRequest =  # UpdateCampaignOffersRequest | 

try:
    # Изменение условий продажи товаров в магазине
    api_response = api_instance.update_campaign_offers(campaignId, updateCampaignOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->updateCampaignOffers: %s\n" % e)
extern crate OffersApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateCampaignOffersRequest = ; // UpdateCampaignOffersRequest

    let mut context = OffersApi::Context::default();
    let result = client.updateCampaignOffers(campaignId, updateCampaignOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateCampaignOffersRequest *

Responses


OrderBusinessInformation

getOrderBusinessBuyerInfo

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY`, `PICKUP` или `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/business-buyer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/business-buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderBusinessInformationApi;

import java.io.File;
import java.util.*;

public class OrderBusinessInformationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderBusinessInformationApi apiInstance = new OrderBusinessInformationApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderBusinessInformationApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessBuyerInfo: $e\n');
}

import org.openapitools.client.api.OrderBusinessInformationApi;

public class OrderBusinessInformationApiExample {
    public static void main(String[] args) {
        OrderBusinessInformationApi apiInstance = new OrderBusinessInformationApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderBusinessInformationApi#getOrderBusinessBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderBusinessInformationApi *apiInstance = [[OrderBusinessInformationApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — юридическом лице
[apiInstance getOrderBusinessBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderBusinessInformationApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderBusinessInformationApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — юридическом лице
                GetBusinessBuyerInfoResponse result = apiInstance.getOrderBusinessBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderBusinessInformationApi.getOrderBusinessBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderBusinessInformationApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderBusinessInformationApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderBusinessInformationApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderBusinessInformationApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderBusinessInformationApi->getOrderBusinessBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderBusinessInformationApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — юридическом лице
    api_response = api_instance.get_order_business_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderBusinessInformationApi->getOrderBusinessBuyerInfo: %s\n" % e)
extern crate OrderBusinessInformationApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = OrderBusinessInformationApi::Context::default();
    let result = client.getOrderBusinessBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrderBusinessDocumentsInfo

Информация о документах

Возвращает информацию о документах по идентификатору заказа. Получить данные можно после того, как заказ перейдет в статус `DELIVERED`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/documents

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderBusinessInformationApi;

import java.io.File;
import java.util.*;

public class OrderBusinessInformationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderBusinessInformationApi apiInstance = new OrderBusinessInformationApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderBusinessInformationApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBusinessDocumentsInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBusinessDocumentsInfo: $e\n');
}

import org.openapitools.client.api.OrderBusinessInformationApi;

public class OrderBusinessInformationApiExample {
    public static void main(String[] args) {
        OrderBusinessInformationApi apiInstance = new OrderBusinessInformationApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderBusinessInformationApi#getOrderBusinessDocumentsInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderBusinessInformationApi *apiInstance = [[OrderBusinessInformationApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о документах
[apiInstance getOrderBusinessDocumentsInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetBusinessDocumentsInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderBusinessInformationApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBusinessDocumentsInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBusinessDocumentsInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderBusinessInformationApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о документах
                GetBusinessDocumentsInfoResponse result = apiInstance.getOrderBusinessDocumentsInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderBusinessInformationApi.getOrderBusinessDocumentsInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderBusinessInformationApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBusinessDocumentsInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderBusinessInformationApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderBusinessInformationApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderBusinessInformationApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBusinessDocumentsInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderBusinessInformationApi->getOrderBusinessDocumentsInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderBusinessInformationApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о документах
    api_response = api_instance.get_order_business_documents_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderBusinessInformationApi->getOrderBusinessDocumentsInfo: %s\n" % e)
extern crate OrderBusinessInformationApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = OrderBusinessInformationApi::Context::default();
    let result = client.getOrderBusinessDocumentsInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


OrderDelivery

getOrderBuyerInfo

Информация о покупателе — физическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом [POST campaigns/{campaignId}/orders/{orderId}/business-buyer](../../reference/order-business-information/getOrderBusinessBuyerInfo.md). {% endnote %} Получить данные можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY` или `PICKUP`. Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса [POST order/status](../../pushapi/reference/postOrderStatus.md). |**⚙️ Лимит:** 3 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/buyer

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/buyer"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderDeliveryApi;

import java.io.File;
import java.util.*;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#getOrderBuyerInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderBuyerInfo(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderBuyerInfo: $e\n');
}

import org.openapitools.client.api.OrderDeliveryApi;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#getOrderBuyerInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderDeliveryApi *apiInstance = [[OrderDeliveryApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация о покупателе — физическом лице
[apiInstance getOrderBuyerInfoWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderBuyerInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderDeliveryApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderBuyerInfo(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderBuyerInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderDeliveryApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация о покупателе — физическом лице
                GetOrderBuyerInfoResponse result = apiInstance.getOrderBuyerInfo(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderDeliveryApi.getOrderBuyerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderDeliveryApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderBuyerInfo($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderDeliveryApi->getOrderBuyerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderDeliveryApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderDeliveryApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderBuyerInfo(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderDeliveryApi->getOrderBuyerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderDeliveryApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация о покупателе — физическом лице
    api_response = api_instance.get_order_buyer_info(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderDeliveryApi->getOrderBuyerInfo: %s\n" % e)
extern crate OrderDeliveryApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = OrderDeliveryApi::Context::default();
    let result = client.getOrderBuyerInfo(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


setOrderDeliveryDate

Изменение даты доставки заказа

Метод изменяет дату доставки заказа в статусе `PROCESSING` или `DELIVERY`. Для заказов с другими статусами дату доставки изменить нельзя. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/date

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/date" \
 -d '{
  "reason" : "USER_MOVED_DELIVERY_DATES",
  "dates" : {
    "toDate" : "2000-01-23"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderDeliveryApi;

import java.io.File;
import java.util.*;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#setOrderDeliveryDate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = new SetOrderDeliveryDateRequest(); // SetOrderDeliveryDateRequest | 

try {
    final result = await api_instance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderDeliveryDate: $e\n');
}

import org.openapitools.client.api.OrderDeliveryApi;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryDateRequest setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#setOrderDeliveryDate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderDeliveryApi *apiInstance = [[OrderDeliveryApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderDeliveryDateRequest *setOrderDeliveryDateRequest = ; // 

// Изменение даты доставки заказа
[apiInstance setOrderDeliveryDateWith:campaignId
    orderId:orderId
    setOrderDeliveryDateRequest:setOrderDeliveryDateRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderDeliveryApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderDeliveryDateRequest = ; // {SetOrderDeliveryDateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderDeliveryDateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderDeliveryApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderDeliveryDateRequest = new SetOrderDeliveryDateRequest(); // SetOrderDeliveryDateRequest | 

            try {
                // Изменение даты доставки заказа
                EmptyApiResponse result = apiInstance.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderDeliveryApi.setOrderDeliveryDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderDeliveryApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest | 

try {
    $result = $api_instance->setOrderDeliveryDate($campaignId, $orderId, $setOrderDeliveryDateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderDeliveryApi->setOrderDeliveryDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderDeliveryApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderDeliveryApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderDeliveryDateRequest = WWW::OPenAPIClient::Object::SetOrderDeliveryDateRequest->new(); # SetOrderDeliveryDateRequest | 

eval {
    my $result = $api_instance->setOrderDeliveryDate(campaignId => $campaignId, orderId => $orderId, setOrderDeliveryDateRequest => $setOrderDeliveryDateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderDeliveryApi->setOrderDeliveryDate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderDeliveryApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderDeliveryDateRequest =  # SetOrderDeliveryDateRequest | 

try:
    # Изменение даты доставки заказа
    api_response = api_instance.set_order_delivery_date(campaignId, orderId, setOrderDeliveryDateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderDeliveryApi->setOrderDeliveryDate: %s\n" % e)
extern crate OrderDeliveryApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderDeliveryDateRequest = ; // SetOrderDeliveryDateRequest

    let mut context = OrderDeliveryApi::Context::default();
    let result = client.setOrderDeliveryDate(campaignId, orderId, setOrderDeliveryDateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderDeliveryDateRequest *

Responses


setOrderDeliveryTrackCode

Передача трек‑номера посылки

{% note warning "Этот запрос только для DBS" %} Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти. {% endnote %} Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки. Передать трек‑номер можно, только если заказ находится в статусе `PROCESSING`, `DELIVERY` или `PICKUP`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/track

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/track" \
 -d '{
  "trackCode" : "trackCode",
  "deliveryServiceId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderDeliveryApi;

import java.io.File;
import java.util.*;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#setOrderDeliveryTrackCode");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = new SetOrderDeliveryTrackCodeRequest(); // SetOrderDeliveryTrackCodeRequest | 

try {
    final result = await api_instance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderDeliveryTrackCode: $e\n');
}

import org.openapitools.client.api.OrderDeliveryApi;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderDeliveryTrackCodeRequest setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

        try {
            EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#setOrderDeliveryTrackCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderDeliveryApi *apiInstance = [[OrderDeliveryApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderDeliveryTrackCodeRequest *setOrderDeliveryTrackCodeRequest = ; // 

// Передача трек‑номера посылки
[apiInstance setOrderDeliveryTrackCodeWith:campaignId
    orderId:orderId
    setOrderDeliveryTrackCodeRequest:setOrderDeliveryTrackCodeRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderDeliveryApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderDeliveryTrackCodeRequest = ; // {SetOrderDeliveryTrackCodeRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderDeliveryTrackCodeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderDeliveryApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderDeliveryTrackCodeRequest = new SetOrderDeliveryTrackCodeRequest(); // SetOrderDeliveryTrackCodeRequest | 

            try {
                // Передача трек‑номера посылки
                EmptyApiResponse result = apiInstance.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderDeliveryApi.setOrderDeliveryTrackCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderDeliveryApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest | 

try {
    $result = $api_instance->setOrderDeliveryTrackCode($campaignId, $orderId, $setOrderDeliveryTrackCodeRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderDeliveryApi->setOrderDeliveryTrackCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderDeliveryApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderDeliveryApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderDeliveryTrackCodeRequest = WWW::OPenAPIClient::Object::SetOrderDeliveryTrackCodeRequest->new(); # SetOrderDeliveryTrackCodeRequest | 

eval {
    my $result = $api_instance->setOrderDeliveryTrackCode(campaignId => $campaignId, orderId => $orderId, setOrderDeliveryTrackCodeRequest => $setOrderDeliveryTrackCodeRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderDeliveryApi->setOrderDeliveryTrackCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderDeliveryApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderDeliveryTrackCodeRequest =  # SetOrderDeliveryTrackCodeRequest | 

try:
    # Передача трек‑номера посылки
    api_response = api_instance.set_order_delivery_track_code(campaignId, orderId, setOrderDeliveryTrackCodeRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderDeliveryApi->setOrderDeliveryTrackCode: %s\n" % e)
extern crate OrderDeliveryApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderDeliveryTrackCodeRequest = ; // SetOrderDeliveryTrackCodeRequest

    let mut context = OrderDeliveryApi::Context::default();
    let result = client.setOrderDeliveryTrackCode(campaignId, orderId, setOrderDeliveryTrackCodeRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderDeliveryTrackCodeRequest *

Responses


updateOrderStorageLimit

Продление срока хранения заказа

Продлевает срок хранения заказа в пункте выдачи продавца. Заказ должен быть в статусе `PICKUP`. Продлить срок можно только один раз, не больше чем на 30 дней. Новый срок хранения можно получить в параметре `outletStorageLimitDate` запроса [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit" \
 -d '{
  "newDate" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderDeliveryApi;

import java.io.File;
import java.util.*;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#updateOrderStorageLimit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = new UpdateOrderStorageLimitRequest(); // UpdateOrderStorageLimitRequest | 

try {
    final result = await api_instance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStorageLimit: $e\n');
}

import org.openapitools.client.api.OrderDeliveryApi;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStorageLimitRequest updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#updateOrderStorageLimit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderDeliveryApi *apiInstance = [[OrderDeliveryApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStorageLimitRequest *updateOrderStorageLimitRequest = ; // 

// Продление срока хранения заказа
[apiInstance updateOrderStorageLimitWith:campaignId
    orderId:orderId
    updateOrderStorageLimitRequest:updateOrderStorageLimitRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderDeliveryApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStorageLimitRequest = ; // {UpdateOrderStorageLimitRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStorageLimitExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderDeliveryApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStorageLimitRequest = new UpdateOrderStorageLimitRequest(); // UpdateOrderStorageLimitRequest | 

            try {
                // Продление срока хранения заказа
                EmptyApiResponse result = apiInstance.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderDeliveryApi.updateOrderStorageLimit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderDeliveryApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest | 

try {
    $result = $api_instance->updateOrderStorageLimit($campaignId, $orderId, $updateOrderStorageLimitRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderDeliveryApi->updateOrderStorageLimit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderDeliveryApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderDeliveryApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStorageLimitRequest = WWW::OPenAPIClient::Object::UpdateOrderStorageLimitRequest->new(); # UpdateOrderStorageLimitRequest | 

eval {
    my $result = $api_instance->updateOrderStorageLimit(campaignId => $campaignId, orderId => $orderId, updateOrderStorageLimitRequest => $updateOrderStorageLimitRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderDeliveryApi->updateOrderStorageLimit: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderDeliveryApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStorageLimitRequest =  # UpdateOrderStorageLimitRequest | 

try:
    # Продление срока хранения заказа
    api_response = api_instance.update_order_storage_limit(campaignId, orderId, updateOrderStorageLimitRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderDeliveryApi->updateOrderStorageLimit: %s\n" % e)
extern crate OrderDeliveryApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStorageLimitRequest = ; // UpdateOrderStorageLimitRequest

    let mut context = OrderDeliveryApi::Context::default();
    let result = client.updateOrderStorageLimit(campaignId, orderId, updateOrderStorageLimitRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStorageLimitRequest *

Responses


verifyOrderEac

Передача кода подтверждения

Отправляет Маркету код подтверждения для его проверки. Код подтверждает передачу заказа или невыкупа: * курьеру — курьер должен назвать магазину код; * магазину — магазин называет код курьеру. Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения. Если у магазина настроена работа с кодами подтверждения, в запросах [POST order/status](../../pushapi/reference/postOrderStatus.md), [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md), [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md), [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) в параметре `delivery`, вложенном в `order` будет возвращаться параметр `eacType` с типом `Enum` — тип кода подтверждения для передачи заказа. Возможные значения: `MERCHANT_TO_COURIER` — магазин называет код курьеру, `COURIER_TO_MERCHANT` — курьер называет код магазину. Параметр `eacType` возвращается при статусах заказа `COURIER_FOUND`, `COURIER_ARRIVED_TO_SENDER` и `DELIVERY_SERVICE_UNDELIVERED`. Если заказ в других статусах, параметр может отсутствовать. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/verifyEac

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/verifyEac" \
 -d '{
  "code" : "code"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderDeliveryApi;

import java.io.File;
import java.util.*;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        VerifyOrderEacRequest verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

        try {
            VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#verifyOrderEac");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final VerifyOrderEacRequest verifyOrderEacRequest = new VerifyOrderEacRequest(); // VerifyOrderEacRequest | 

try {
    final result = await api_instance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->verifyOrderEac: $e\n');
}

import org.openapitools.client.api.OrderDeliveryApi;

public class OrderDeliveryApiExample {
    public static void main(String[] args) {
        OrderDeliveryApi apiInstance = new OrderDeliveryApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        VerifyOrderEacRequest verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

        try {
            VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderDeliveryApi#verifyOrderEac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderDeliveryApi *apiInstance = [[OrderDeliveryApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
VerifyOrderEacRequest *verifyOrderEacRequest = ; // 

// Передача кода подтверждения
[apiInstance verifyOrderEacWith:campaignId
    orderId:orderId
    verifyOrderEacRequest:verifyOrderEacRequest
              completionHandler: ^(VerifyOrderEacResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderDeliveryApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var verifyOrderEacRequest = ; // {VerifyOrderEacRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class verifyOrderEacExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderDeliveryApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var verifyOrderEacRequest = new VerifyOrderEacRequest(); // VerifyOrderEacRequest | 

            try {
                // Передача кода подтверждения
                VerifyOrderEacResponse result = apiInstance.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderDeliveryApi.verifyOrderEac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderDeliveryApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$verifyOrderEacRequest = ; // VerifyOrderEacRequest | 

try {
    $result = $api_instance->verifyOrderEac($campaignId, $orderId, $verifyOrderEacRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderDeliveryApi->verifyOrderEac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderDeliveryApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderDeliveryApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $verifyOrderEacRequest = WWW::OPenAPIClient::Object::VerifyOrderEacRequest->new(); # VerifyOrderEacRequest | 

eval {
    my $result = $api_instance->verifyOrderEac(campaignId => $campaignId, orderId => $orderId, verifyOrderEacRequest => $verifyOrderEacRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderDeliveryApi->verifyOrderEac: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderDeliveryApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
verifyOrderEacRequest =  # VerifyOrderEacRequest | 

try:
    # Передача кода подтверждения
    api_response = api_instance.verify_order_eac(campaignId, orderId, verifyOrderEacRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderDeliveryApi->verifyOrderEac: %s\n" % e)
extern crate OrderDeliveryApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let verifyOrderEacRequest = ; // VerifyOrderEacRequest

    let mut context = OrderDeliveryApi::Context::default();
    let result = client.verifyOrderEac(campaignId, orderId, verifyOrderEacRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
verifyOrderEacRequest *

Responses


OrderLabels

generateOrderLabel

Готовый ярлык‑наклейка для коробки в заказе

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderLabelsApi;

import java.io.File;
import java.util.*;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Идентификатор грузоместа.
final Long boxId = new Long(); // Long | Идентификатор коробки.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabel: $e\n');
}

import org.openapitools.client.api.OrderLabelsApi;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Идентификатор грузоместа.
        Long boxId = 789; // Long | Идентификатор коробки.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#generateOrderLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderLabelsApi *apiInstance = [[OrderLabelsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Идентификатор грузоместа. (default to null)
Long *boxId = 789; // Идентификатор коробки. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовый ярлык‑наклейка для коробки в заказе
[apiInstance generateOrderLabelWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    boxId:boxId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderLabelsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Идентификатор грузоместа.
var boxId = 789; // {Long} Идентификатор коробки.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabel(campaignId, orderId, shipmentId, boxId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderLabelsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Идентификатор грузоместа. (default to null)
            var boxId = 789;  // Long | Идентификатор коробки. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовый ярлык‑наклейка для коробки в заказе
                File result = apiInstance.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderLabelsApi.generateOrderLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderLabelsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Идентификатор грузоместа.
$boxId = 789; // Long | Идентификатор коробки.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabel($campaignId, $orderId, $shipmentId, $boxId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderLabelsApi->generateOrderLabel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderLabelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderLabelsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Идентификатор грузоместа.
my $boxId = 789; # Long | Идентификатор коробки.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabel(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, boxId => $boxId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderLabelsApi->generateOrderLabel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderLabelsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Идентификатор грузоместа. (default to null)
boxId = 789 # Long | Идентификатор коробки. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовый ярлык‑наклейка для коробки в заказе
    api_response = api_instance.generate_order_label(campaignId, orderId, shipmentId, boxId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderLabelsApi->generateOrderLabel: %s\n" % e)
extern crate OrderLabelsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let boxId = 789; // Long
    let format = ; // PageFormatType

    let mut context = OrderLabelsApi::Context::default();
    let result = client.generateOrderLabel(campaignId, orderId, shipmentId, boxId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Идентификатор грузоместа.
Required
boxId*
Long (int64)
Идентификатор коробки.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


generateOrderLabels

Готовые ярлыки‑наклейки на все коробки в одном заказе

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderLabelsApi;

import java.io.File;
import java.util.*;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    final result = await api_instance.generateOrderLabels(campaignId, orderId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateOrderLabels: $e\n');
}

import org.openapitools.client.api.OrderLabelsApi;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

        try {
            File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#generateOrderLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderLabelsApi *apiInstance = [[OrderLabelsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в одном заказе
[apiInstance generateOrderLabelsWith:campaignId
    orderId:orderId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderLabelsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateOrderLabels(campaignId, orderId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateOrderLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderLabelsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в одном заказе
                File result = apiInstance.generateOrderLabels(campaignId, orderId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderLabelsApi.generateOrderLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderLabelsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $api_instance->generateOrderLabels($campaignId, $orderId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderLabelsApi->generateOrderLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderLabelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderLabelsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

eval {
    my $result = $api_instance->generateOrderLabels(campaignId => $campaignId, orderId => $orderId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderLabelsApi->generateOrderLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderLabelsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в одном заказе
    api_response = api_instance.generate_order_labels(campaignId, orderId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderLabelsApi->generateOrderLabels: %s\n" % e)
extern crate OrderLabelsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let format = ; // PageFormatType

    let mut context = OrderLabelsApi::Context::default();
    let result = client.generateOrderLabels(campaignId, orderId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

Responses


getOrderLabelsData

Данные для самостоятельного изготовления ярлыков

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrderLabelsApi;

import java.io.File;
import java.util.*;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrderLabelsData(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrderLabelsData: $e\n');
}

import org.openapitools.client.api.OrderLabelsApi;

public class OrderLabelsApiExample {
    public static void main(String[] args) {
        OrderLabelsApi apiInstance = new OrderLabelsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderLabelsApi#getOrderLabelsData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrderLabelsApi *apiInstance = [[OrderLabelsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Данные для самостоятельного изготовления ярлыков
[apiInstance getOrderLabelsDataWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderLabelsDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrderLabelsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderLabelsData(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderLabelsDataExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrderLabelsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Данные для самостоятельного изготовления ярлыков
                GetOrderLabelsDataResponse result = apiInstance.getOrderLabelsData(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrderLabelsApi.getOrderLabelsData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrderLabelsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrderLabelsData($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderLabelsApi->getOrderLabelsData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrderLabelsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrderLabelsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrderLabelsData(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderLabelsApi->getOrderLabelsData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrderLabelsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Данные для самостоятельного изготовления ярлыков
    api_response = api_instance.get_order_labels_data(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderLabelsApi->getOrderLabelsData: %s\n" % e)
extern crate OrderLabelsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = OrderLabelsApi::Context::default();
    let result = client.getOrderLabelsData(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


Orders

acceptOrderCancellation

Отмена заказа покупателем

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки. Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически. Если заказ уже передан службе доставки (принимает статус `DELIVERY` или `PICKUP`) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation.md). Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут. Чтобы узнать, какие заказы были отменены в статусе `DELIVERY` или `PICKUP`, отправьте запрос [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). В его URL добавьте входной параметр `onlyWaitingForCancellationApprove=true`. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене. Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически. |**⚙️ Лимит:** 500 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/cancellation/accept

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/cancellation/accept" \
 -d '{
  "reason" : "ORDER_DELIVERED",
  "accepted" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        AcceptOrderCancellationRequest acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

        try {
            EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#acceptOrderCancellation");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final AcceptOrderCancellationRequest acceptOrderCancellationRequest = new AcceptOrderCancellationRequest(); // AcceptOrderCancellationRequest | 

try {
    final result = await api_instance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->acceptOrderCancellation: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        AcceptOrderCancellationRequest acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

        try {
            EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#acceptOrderCancellation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
AcceptOrderCancellationRequest *acceptOrderCancellationRequest = ; // 

// Отмена заказа покупателем
[apiInstance acceptOrderCancellationWith:campaignId
    orderId:orderId
    acceptOrderCancellationRequest:acceptOrderCancellationRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var acceptOrderCancellationRequest = ; // {AcceptOrderCancellationRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class acceptOrderCancellationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var acceptOrderCancellationRequest = new AcceptOrderCancellationRequest(); // AcceptOrderCancellationRequest | 

            try {
                // Отмена заказа покупателем
                EmptyApiResponse result = apiInstance.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.acceptOrderCancellation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest | 

try {
    $result = $api_instance->acceptOrderCancellation($campaignId, $orderId, $acceptOrderCancellationRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->acceptOrderCancellation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $acceptOrderCancellationRequest = WWW::OPenAPIClient::Object::AcceptOrderCancellationRequest->new(); # AcceptOrderCancellationRequest | 

eval {
    my $result = $api_instance->acceptOrderCancellation(campaignId => $campaignId, orderId => $orderId, acceptOrderCancellationRequest => $acceptOrderCancellationRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->acceptOrderCancellation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
acceptOrderCancellationRequest =  # AcceptOrderCancellationRequest | 

try:
    # Отмена заказа покупателем
    api_response = api_instance.accept_order_cancellation(campaignId, orderId, acceptOrderCancellationRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->acceptOrderCancellation: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let acceptOrderCancellationRequest = ; // AcceptOrderCancellationRequest

    let mut context = OrdersApi::Context::default();
    let result = client.acceptOrderCancellation(campaignId, orderId, acceptOrderCancellationRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
acceptOrderCancellationRequest *

Responses


getOrder

Информация об одном заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#getOrder");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.

try {
    final result = await api_instance.getOrder(campaignId, orderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrder: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.

        try {
            GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)

// Информация об одном заказе
[apiInstance getOrderWith:campaignId
    orderId:orderId
              completionHandler: ^(GetOrderResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(campaignId, orderId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)

            try {
                // Информация об одном заказе
                GetOrderResponse result = apiInstance.getOrder(campaignId, orderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.

try {
    $result = $api_instance->getOrder($campaignId, $orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.

eval {
    my $result = $api_instance->getOrder(campaignId => $campaignId, orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)

try:
    # Информация об одном заказе
    api_response = api_instance.get_order(campaignId, orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->getOrder: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long

    let mut context = OrdersApi::Context::default();
    let result = client.getOrder(campaignId, orderId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required

Responses


getOrders

Информация о нескольких заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * идентификаторам заказов; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md) (если у вас есть идентификатор заказа) или запроса отчета по заказам [POST campaigns/{campaignId}/stats/orders](../../reference/stats/getOrdersStats.md). Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Для навигации по страницам используйте параметры `page_token` и `limit`. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса [GET campaigns/{campaignId}/orders/{orderId}/buyer](../../reference/orders/getOrderBuyerInfo.md). |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders?orderIds=&status=&substatus=&fromDate=2013-10-20&toDate=2013-10-20&supplierShipmentDateFrom=2013-10-20&supplierShipmentDateTo=2013-10-20&updatedAtFrom=2013-10-20T19:20:30+01:00&updatedAtTo=2013-10-20T19:20:30+01:00&dispatchType=&fake=true&hasCis=true&onlyWaitingForCancellationApprove=true&onlyEstimatedDelivery=true&buyerType=&page=56&pageSize=56&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrdersApi#getOrders"); e.printStackTrace(); } } }
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final array[Long] orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. final set[OrderStatusType] status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. final set[OrderSubstatusType] substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. final date fromDate = new date(); // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. final date toDate = new date(); // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. final date supplierShipmentDateFrom = new date(); // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final date supplierShipmentDateTo = new date(); // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final Date updatedAtFrom = new Date(); // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. final Date updatedAtTo = new Date(); // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. final OrderDeliveryDispatchType dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки final Boolean fake = new Boolean(); // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. final Boolean hasCis = new Boolean(); // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. final Boolean onlyWaitingForCancellationApprove = new Boolean(); // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). final Boolean onlyEstimatedDelivery = new Boolean(); // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. final OrderBuyerType buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. final Integer page = new Integer(); // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. final Integer pageSize = new Integer(); // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. final String pageToken = new String(); // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. final Integer limit = new Integer(); // Integer | Количество значений на одной странице. try { final result = await api_instance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); print(result); } catch (e) { print('Exception when calling DefaultApi->getOrders: $e\n'); }
import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        array[Long] orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. set[OrderStatusType] status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. set[OrderSubstatusType] substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. date fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. date toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. date supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. date supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Date updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. Date updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. OrderDeliveryDispatchType dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки Boolean fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. Boolean hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Boolean onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). Boolean onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. OrderBuyerType buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. Integer page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. Integer pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Integer limit = 20; // Integer | Количество значений на одной странице. try { GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrdersApi#getOrders"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
array[Long] *orderIds = ; // Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) set[OrderStatusType] *status = ; // Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) set[OrderSubstatusType] *substatus = ; // Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) date *fromDate = 2013-10-20; // Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) date *toDate = 2013-10-20; // Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) date *supplierShipmentDateFrom = 2013-10-20; // Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) date *supplierShipmentDateTo = 2013-10-20; // Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtFrom = 2013-10-20T19:20:30+01:00; // Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) Date *updatedAtTo = 2013-10-20T19:20:30+01:00; // Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) OrderDeliveryDispatchType *dispatchType = ; // Способ отгрузки (optional) (default to null) Boolean *fake = true; // Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) Boolean *hasCis = true; // Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) Boolean *onlyWaitingForCancellationApprove = true; // **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) Boolean *onlyEstimatedDelivery = true; // Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) OrderBuyerType *buyerType = ; // Фильтрация заказов по типу покупателя. (optional) (default to null) Integer *page = 56; // Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) Integer *pageSize = 56; // Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) Integer *limit = 20; // Количество значений на одной странице. (optional) (default to null) // Информация о нескольких заказах [apiInstance getOrdersWith:campaignId orderIds:orderIds status:status substatus:substatus fromDate:fromDate toDate:toDate supplierShipmentDateFrom:supplierShipmentDateFrom supplierShipmentDateTo:supplierShipmentDateTo updatedAtFrom:updatedAtFrom updatedAtTo:updatedAtTo dispatchType:dispatchType fake:fake hasCis:hasCis onlyWaitingForCancellationApprove:onlyWaitingForCancellationApprove onlyEstimatedDelivery:onlyEstimatedDelivery buyerType:buyerType page:page pageSize:pageSize pageToken:pageToken limit:limit completionHandler: ^(GetOrdersResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'orderIds': , // {array[Long]} Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. 'status': , // {set[OrderStatusType]} Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. 'substatus': , // {set[OrderSubstatusType]} Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. 'fromDate': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. 'toDate': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. 'supplierShipmentDateFrom': 2013-10-20, // {date} Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'supplierShipmentDateTo': 2013-10-20, // {date} Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'updatedAtFrom': 2013-10-20T19:20:30+01:00, // {Date} Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. 'updatedAtTo': 2013-10-20T19:20:30+01:00, // {Date} Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. 'dispatchType': , // {OrderDeliveryDispatchType} Способ отгрузки 'fake': true, // {Boolean} Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. 'hasCis': true, // {Boolean} Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. 'onlyWaitingForCancellationApprove': true, // {Boolean} **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). 'onlyEstimatedDelivery': true, // {Boolean} Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. 'buyerType': , // {OrderBuyerType} Фильтрация заказов по типу покупателя. 'page': 56, // {Integer} Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageSize': 56, // {Integer} Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. 'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. 'limit': 20 // {Integer} Количество значений на одной странице. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getOrders(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderIds = new array[Long](); // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) var status = new set[OrderStatusType](); // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var substatus = new set[OrderSubstatusType](); // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) var fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) var toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) var supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) var updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) var dispatchType = new OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) var fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) var hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) var onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) var onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) var buyerType = new OrderBuyerType(); // OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) var page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) var pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) var limit = 20; // Integer | Количество значений на одной странице. (optional) (default to null) try { // Информация о нескольких заказах GetOrdersResponse result = apiInstance.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling OrdersApi.getOrders: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderIds = ; // array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. $status = ; // set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. $substatus = ; // set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. $fromDate = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. $toDate = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. $supplierShipmentDateFrom = 2013-10-20; // date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $supplierShipmentDateTo = 2013-10-20; // date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. $updatedAtTo = 2013-10-20T19:20:30+01:00; // Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. $dispatchType = ; // OrderDeliveryDispatchType | Способ отгрузки $fake = true; // Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. $hasCis = true; // Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. $onlyWaitingForCancellationApprove = true; // Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). $onlyEstimatedDelivery = true; // Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. $buyerType = ; // OrderBuyerType | Фильтрация заказов по типу покупателя. $page = 56; // Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. $pageSize = 56; // Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. $limit = 20; // Integer | Количество значений на одной странице. try { $result = $api_instance->getOrders($campaignId, $orderIds, $status, $substatus, $fromDate, $toDate, $supplierShipmentDateFrom, $supplierShipmentDateTo, $updatedAtFrom, $updatedAtTo, $dispatchType, $fake, $hasCis, $onlyWaitingForCancellationApprove, $onlyEstimatedDelivery, $buyerType, $page, $pageSize, $pageToken, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling OrdersApi->getOrders: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderIds = []; # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. my $status = []; # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. my $substatus = []; # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. my $fromDate = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. my $toDate = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. my $supplierShipmentDateFrom = 2013-10-20; # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $supplierShipmentDateTo = 2013-10-20; # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $updatedAtFrom = 2013-10-20T19:20:30+01:00; # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. my $updatedAtTo = 2013-10-20T19:20:30+01:00; # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. my $dispatchType = ; # OrderDeliveryDispatchType | Способ отгрузки my $fake = true; # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. my $hasCis = true; # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. my $onlyWaitingForCancellationApprove = true; # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). my $onlyEstimatedDelivery = true; # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. my $buyerType = ; # OrderBuyerType | Фильтрация заказов по типу покупателя. my $page = 56; # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageSize = 56; # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. my $limit = 20; # Integer | Количество значений на одной странице. eval { my $result = $api_instance->getOrders(campaignId => $campaignId, orderIds => $orderIds, status => $status, substatus => $substatus, fromDate => $fromDate, toDate => $toDate, supplierShipmentDateFrom => $supplierShipmentDateFrom, supplierShipmentDateTo => $supplierShipmentDateTo, updatedAtFrom => $updatedAtFrom, updatedAtTo => $updatedAtTo, dispatchType => $dispatchType, fake => $fake, hasCis => $hasCis, onlyWaitingForCancellationApprove => $onlyWaitingForCancellationApprove, onlyEstimatedDelivery => $onlyEstimatedDelivery, buyerType => $buyerType, page => $page, pageSize => $pageSize, pageToken => $pageToken, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling OrdersApi->getOrders: $@\n"; }
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderIds =  # array[Long] | Фильтрация заказов по идентификаторам.


⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. (optional) (default to null) status = # set[OrderStatusType] | Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) substatus = # set[OrderSubstatusType] | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется. (optional) (default to null) fromDate = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты. (optional) (default to null) toDate = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. (optional) (default to null) supplierShipmentDateFrom = 2013-10-20 # date | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) supplierShipmentDateTo = 2013-10-20 # date | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) updatedAtFrom = 2013-10-20T19:20:30+01:00 # Date | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации. (optional) (default to null) updatedAtTo = 2013-10-20T19:20:30+01:00 # Date | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. (optional) (default to null) dispatchType = # OrderDeliveryDispatchType | Способ отгрузки (optional) (default to null) fake = true # Boolean | Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета. (optional) (default to false) hasCis = true # Boolean | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. (optional) (default to false) onlyWaitingForCancellationApprove = true # Boolean | **Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation). (optional) (default to false) onlyEstimatedDelivery = true # Boolean | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется. (optional) (default to false) buyerType = # OrderBuyerType | Фильтрация заказов по типу покупателя. (optional) (default to null) page = 56 # Integer | Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to 1) pageSize = 56 # Integer | Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`. (optional) (default to null) pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. (optional) (default to null) limit = 20 # Integer | Количество значений на одной странице. (optional) (default to null) try: # Информация о нескольких заказах api_response = api_instance.get_orders(campaignId, orderIds=orderIds, status=status, substatus=substatus, fromDate=fromDate, toDate=toDate, supplierShipmentDateFrom=supplierShipmentDateFrom, supplierShipmentDateTo=supplierShipmentDateTo, updatedAtFrom=updatedAtFrom, updatedAtTo=updatedAtTo, dispatchType=dispatchType, fake=fake, hasCis=hasCis, onlyWaitingForCancellationApprove=onlyWaitingForCancellationApprove, onlyEstimatedDelivery=onlyEstimatedDelivery, buyerType=buyerType, page=page, pageSize=pageSize, pageToken=pageToken, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling OrdersApi->getOrders: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderIds = ; // array[Long]
    let status = ; // set[OrderStatusType]
    let substatus = ; // set[OrderSubstatusType]
    let fromDate = 2013-10-20; // date
    let toDate = 2013-10-20; // date
    let supplierShipmentDateFrom = 2013-10-20; // date
    let supplierShipmentDateTo = 2013-10-20; // date
    let updatedAtFrom = 2013-10-20T19:20:30+01:00; // Date
    let updatedAtTo = 2013-10-20T19:20:30+01:00; // Date
    let dispatchType = ; // OrderDeliveryDispatchType
    let fake = true; // Boolean
    let hasCis = true; // Boolean
    let onlyWaitingForCancellationApprove = true; // Boolean
    let onlyEstimatedDelivery = true; // Boolean
    let buyerType = ; // OrderBuyerType
    let page = 56; // Integer
    let pageSize = 56; // Integer
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = OrdersApi::Context::default();
    let result = client.getOrders(campaignId, orderIds, status, substatus, fromDate, toDate, supplierShipmentDateFrom, supplierShipmentDateTo, updatedAtFrom, updatedAtTo, dispatchType, fake, hasCis, onlyWaitingForCancellationApprove, onlyEstimatedDelivery, buyerType, page, pageSize, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
orderIds
array[Long] (int64)
Фильтрация заказов по идентификаторам. <br><br> ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
status
set[OrderStatusType]
Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus
set[OrderSubstatusType]
Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.
fromDate
date (date)
Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
toDate
date (date)
Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.
supplierShipmentDateFrom
date (date)
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo
date (date)
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
updatedAtFrom
Date (date-time)
Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo
Date (date-time)
Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.
dispatchType
OrderDeliveryDispatchType
Способ отгрузки
fake
Boolean
Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
hasCis
Boolean
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации [в системе «Честный ЗНАК»](https://честныйзнак.рф/): * `true` — да. * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
onlyWaitingForCancellationApprove
Boolean
**Только для модели DBS** Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
onlyEstimatedDelivery
Boolean
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
buyerType
OrderBuyerType
Фильтрация заказов по типу покупателя.
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


provideOrderDigitalCodes

Передача ключей цифровых товаров

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус `DELIVERED`. Ключ нужно передать в течение 30 минут после перехода заказа в статус `PROCESSING`. Если в один заказ входят несколько ключей, передавайте их все в одном запросе. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods" \
 -d '{
  "items" : [ {
    "activate_till" : "2000-01-23",
    "code" : "code",
    "slip" : "slip",
    "id" : 0
  }, {
    "activate_till" : "2000-01-23",
    "code" : "code",
    "slip" : "slip",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

        try {
            EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#provideOrderDigitalCodes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = new ProvideOrderDigitalCodesRequest(); // ProvideOrderDigitalCodesRequest | 

try {
    final result = await api_instance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderDigitalCodes: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderDigitalCodesRequest provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

        try {
            EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#provideOrderDigitalCodes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderDigitalCodesRequest *provideOrderDigitalCodesRequest = ; // 

// Передача ключей цифровых товаров
[apiInstance provideOrderDigitalCodesWith:campaignId
    orderId:orderId
    provideOrderDigitalCodesRequest:provideOrderDigitalCodesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderDigitalCodesRequest = ; // {ProvideOrderDigitalCodesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderDigitalCodesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderDigitalCodesRequest = new ProvideOrderDigitalCodesRequest(); // ProvideOrderDigitalCodesRequest | 

            try {
                // Передача ключей цифровых товаров
                EmptyApiResponse result = apiInstance.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.provideOrderDigitalCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest | 

try {
    $result = $api_instance->provideOrderDigitalCodes($campaignId, $orderId, $provideOrderDigitalCodesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->provideOrderDigitalCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderDigitalCodesRequest = WWW::OPenAPIClient::Object::ProvideOrderDigitalCodesRequest->new(); # ProvideOrderDigitalCodesRequest | 

eval {
    my $result = $api_instance->provideOrderDigitalCodes(campaignId => $campaignId, orderId => $orderId, provideOrderDigitalCodesRequest => $provideOrderDigitalCodesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->provideOrderDigitalCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderDigitalCodesRequest =  # ProvideOrderDigitalCodesRequest | 

try:
    # Передача ключей цифровых товаров
    api_response = api_instance.provide_order_digital_codes(campaignId, orderId, provideOrderDigitalCodesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->provideOrderDigitalCodes: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderDigitalCodesRequest = ; // ProvideOrderDigitalCodesRequest

    let mut context = OrdersApi::Context::default();
    let result = client.provideOrderDigitalCodes(campaignId, orderId, provideOrderDigitalCodesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderDigitalCodesRequest *

Responses


provideOrderItemIdentifiers

Передача кодов маркировки единиц товара

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Передает Маркету коды маркировки для единиц товара в указанном заказе. Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. {% note warning %} Прежде чем работать с этим методом, обязательно прочтите [статью о работе с маркируемыми товарами](https://yandex.ru/support/marketplace/orders/cz.html). {% endnote %} Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/identifiers

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers" \
 -d '{
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

try {
    final result = await api_instance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideOrderItemIdentifiers: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        ProvideOrderItemIdentifiersRequest provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

        try {
            ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#provideOrderItemIdentifiers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
ProvideOrderItemIdentifiersRequest *provideOrderItemIdentifiersRequest = ; // 

// Передача кодов маркировки единиц товара
[apiInstance provideOrderItemIdentifiersWith:campaignId
    orderId:orderId
    provideOrderItemIdentifiersRequest:provideOrderItemIdentifiersRequest
              completionHandler: ^(ProvideOrderItemIdentifiersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var provideOrderItemIdentifiersRequest = ; // {ProvideOrderItemIdentifiersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class provideOrderItemIdentifiersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var provideOrderItemIdentifiersRequest = new ProvideOrderItemIdentifiersRequest(); // ProvideOrderItemIdentifiersRequest | 

            try {
                // Передача кодов маркировки единиц товара
                ProvideOrderItemIdentifiersResponse result = apiInstance.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.provideOrderItemIdentifiers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest | 

try {
    $result = $api_instance->provideOrderItemIdentifiers($campaignId, $orderId, $provideOrderItemIdentifiersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->provideOrderItemIdentifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $provideOrderItemIdentifiersRequest = WWW::OPenAPIClient::Object::ProvideOrderItemIdentifiersRequest->new(); # ProvideOrderItemIdentifiersRequest | 

eval {
    my $result = $api_instance->provideOrderItemIdentifiers(campaignId => $campaignId, orderId => $orderId, provideOrderItemIdentifiersRequest => $provideOrderItemIdentifiersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->provideOrderItemIdentifiers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
provideOrderItemIdentifiersRequest =  # ProvideOrderItemIdentifiersRequest | 

try:
    # Передача кодов маркировки единиц товара
    api_response = api_instance.provide_order_item_identifiers(campaignId, orderId, provideOrderItemIdentifiersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->provideOrderItemIdentifiers: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let provideOrderItemIdentifiersRequest = ; // ProvideOrderItemIdentifiersRequest

    let mut context = OrdersApi::Context::default();
    let result = client.provideOrderItemIdentifiers(campaignId, orderId, provideOrderItemIdentifiersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
provideOrderItemIdentifiersRequest *

Responses


setOrderBoxLayout

Подготовка заказа

{% note tip "Подходит и для DBS" %} Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно. {% endnote %} Позволяет выполнить три операции: * передать Маркету информацию о распределении товаров по коробкам; * передать Маркету коды маркировки для товаров; * удалить товар из заказа, если его не оказалось на складе. Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус **Готов к отгрузке**. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново. ## Как передать информацию о распределении товаров В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов: * **Содержащие товары целиком.** Такая коробка может содержать сколько угодно единиц любых товаров. * **Содержащие часть товара.** Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок. ⚠️ Одна коробка не может содержать и товары целиком, и части товаров. ## Как передавать коды маркировки Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. [Что такое маркировка?](https://yandex.ru/support/marketplace/orders/cz.html) Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них. ## Как удалить товар из заказа Чтобы удалить товар из заказа: 1. Добавьте в запрос `allowRemove: true`. 2. Передайте распределение по коробкам без товара, который нужно удалить. {% note warning "Удаление нельзя отменить" %} Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится. {% endnote %} Чтобы удалить позицию целиком, не передавайте соответствующий `OrderBoxLayoutItemDTO`. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле `fullCount`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} ## Примеры {% cut "Товар умещается в коробку" %} Вот как будет выглядеть запрос, если в одной коробке едут: * три единицы одного товара, требующего маркировки; * одна единица другого товара, не требущего маркировки. ```json { "boxes": [ { "items": [ { "id": 123456, "fullCount": 3, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" }, { "cis": "010304109478gftJ14545762!\u001dhGt264" }, { "cis": "010304109478fRs28323ks23!\u001dhet201" } ] }, { "id": 654321, "fullCount": 1 } ] } ] } ``` {% endcut %} {% cut "Товар едет в разных коробках" %} Вот как будет выглядеть запрос, если товар едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} {% cut "Одинаковые товары, где каждый едет в нескольких коробках" %} Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках: ```json { "boxes": [ { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 1, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] }, { "items": [ { "id": 123456, "partialCount": { "current": 2, "total": 2 }, "instances": [ { "cis": "01030410947874432155Qbag!\u001d93Zjqw" } ] } ] } ] } ``` {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/boxes" \
 -d '{
  "boxes" : [ {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  }, {
    "items" : [ {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    }, {
      "partialCount" : {
        "current" : 1,
        "total" : 2
      },
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "id" : 0,
      "fullCount" : 1
    } ]
  } ],
  "allowRemove" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

try {
    final result = await api_instance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderBoxLayout: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        SetOrderBoxLayoutRequest setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

        try {
            SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#setOrderBoxLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
SetOrderBoxLayoutRequest *setOrderBoxLayoutRequest = ; // 

// Подготовка заказа
[apiInstance setOrderBoxLayoutWith:campaignId
    orderId:orderId
    setOrderBoxLayoutRequest:setOrderBoxLayoutRequest
              completionHandler: ^(SetOrderBoxLayoutResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var setOrderBoxLayoutRequest = ; // {SetOrderBoxLayoutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderBoxLayoutExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var setOrderBoxLayoutRequest = new SetOrderBoxLayoutRequest(); // SetOrderBoxLayoutRequest | 

            try {
                // Подготовка заказа
                SetOrderBoxLayoutResponse result = apiInstance.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.setOrderBoxLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest | 

try {
    $result = $api_instance->setOrderBoxLayout($campaignId, $orderId, $setOrderBoxLayoutRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->setOrderBoxLayout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $setOrderBoxLayoutRequest = WWW::OPenAPIClient::Object::SetOrderBoxLayoutRequest->new(); # SetOrderBoxLayoutRequest | 

eval {
    my $result = $api_instance->setOrderBoxLayout(campaignId => $campaignId, orderId => $orderId, setOrderBoxLayoutRequest => $setOrderBoxLayoutRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->setOrderBoxLayout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
setOrderBoxLayoutRequest =  # SetOrderBoxLayoutRequest | 

try:
    # Подготовка заказа
    api_response = api_instance.set_order_box_layout(campaignId, orderId, setOrderBoxLayoutRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->setOrderBoxLayout: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let setOrderBoxLayoutRequest = ; // SetOrderBoxLayoutRequest

    let mut context = OrdersApi::Context::default();
    let result = client.setOrderBoxLayout(campaignId, orderId, setOrderBoxLayoutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
setOrderBoxLayoutRequest *

Responses


setOrderShipmentBoxes

Передача количества грузовых мест в заказе

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест. Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус **Готов к отгрузке**. Подробно о том, что в какой момент нужно передавать, рассказано в [пошаговой инструкции](../../step-by-step/fbs.md). Метод устроен немного нестандартно: количество задается длиной массива пустых объектов. Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому. {% cut "Как было раньше" %} Структура тела PUT-запроса: ``` { "boxes": [ { "fulfilmentId": "{string}", "weight": {int64}, "width": {int64}, "height": {int64}, "depth": {int64}, "items": [ { "id": {int64}, "count": {int32} }, ... ] }, ... ] } ``` | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `boxes` | | Список грузовых мест. | **Параметры, вложенные в `boxes`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `fulfilmentId` | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: `номер заказа на Маркете-номер грузового места`. Например, `7206821‑1, 7206821‑2` и т. д. | | `weight` | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | `width` | Int64 | Ширина грузового места в сантиметрах. | | `height` | Int64 | Высота грузового места в сантиметрах. | | `depth` | Int64 | Глубина грузового места в сантиметрах. | | `items` | Int64 | Список товаров в грузовом месте. | **Параметры, вложенные в `items`** | **Параметр** | **Тип** | **Значение** | | ----------- | ----------- | ----------- | | `id` | Int64 | Идентификатор товара в рамках заказа. | | `count` | Int32 | Количество единиц товара в грузовом месте. | {% endcut %} |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes" \
 -d '{
  "boxes" : [ {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  }, {
    "fulfilmentId" : "fulfilmentId",
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long shipmentId = new Long(); // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

final SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

try {
    final result = await api_instance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setOrderShipmentBoxes: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

        SetOrderShipmentBoxesRequest setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

        try {
            SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#setOrderShipmentBoxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *shipmentId = 789; // Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
SetOrderShipmentBoxesRequest *setOrderShipmentBoxesRequest = ; // 

// Передача количества грузовых мест в заказе
[apiInstance setOrderShipmentBoxesWith:campaignId
    orderId:orderId
    shipmentId:shipmentId
    setOrderShipmentBoxesRequest:setOrderShipmentBoxesRequest
              completionHandler: ^(SetOrderShipmentBoxesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var shipmentId = 789; // {Long} Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

var setOrderShipmentBoxesRequest = ; // {SetOrderShipmentBoxesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setOrderShipmentBoxesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var shipmentId = 789;  // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
            var setOrderShipmentBoxesRequest = new SetOrderShipmentBoxesRequest(); // SetOrderShipmentBoxesRequest | 

            try {
                // Передача количества грузовых мест в заказе
                SetOrderShipmentBoxesResponse result = apiInstance.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.setOrderShipmentBoxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$shipmentId = 789; // Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

$setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest | 

try {
    $result = $api_instance->setOrderShipmentBoxes($campaignId, $orderId, $shipmentId, $setOrderShipmentBoxesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->setOrderShipmentBoxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $shipmentId = 789; # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

my $setOrderShipmentBoxesRequest = WWW::OPenAPIClient::Object::SetOrderShipmentBoxesRequest->new(); # SetOrderShipmentBoxesRequest | 

eval {
    my $result = $api_instance->setOrderShipmentBoxes(campaignId => $campaignId, orderId => $orderId, shipmentId => $shipmentId, setOrderShipmentBoxesRequest => $setOrderShipmentBoxesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->setOrderShipmentBoxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
shipmentId = 789 # Long | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
 (default to null)
setOrderShipmentBoxesRequest =  # SetOrderShipmentBoxesRequest | 

try:
    # Передача количества грузовых мест в заказе
    api_response = api_instance.set_order_shipment_boxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->setOrderShipmentBoxes: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let shipmentId = 789; // Long
    let setOrderShipmentBoxesRequest = ; // SetOrderShipmentBoxesRequest

    let mut context = OrdersApi::Context::default();
    let result = client.setOrderShipmentBoxes(campaignId, orderId, shipmentId, setOrderShipmentBoxesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
shipmentId*
Long (int64)
Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
Required
Body parameters
Name Description
setOrderShipmentBoxesRequest *

Responses


updateOrderItems

Удаление товара из заказа или уменьшение числа единиц

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь [PUT campaigns/{campaignId}/orders/{orderId}/boxes](../../reference/orders/setOrderBoxLayout.md). {% endnote %} Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях: * покупатель уменьшил количество товара; * магазин не может поставить все товары в заказе. Для этого заказ должен находится в статусе `"status": "PROCESSING"` этапа обработки `"substatus": "STARTED"`. После передачи статуса `"substatus": "READY_TO_SHIP"` изменить состав невозможно. Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте `count` параметра `item`. Чтобы полностью удалить товар из заказа: * передайте значение `0`; или * не передавайте параметр `item`. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом [PUT campaigns/{campaignId}/orders/{orderId}/status](../../reference/orders/updateOrderStatus.md) и передайте статус заказа `CANCELLED` с причиной отмены `SHOP_FAILED`. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} **Возврат денег покупателю** Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней: * при оплате банковской картой — с момента, когда магазин переведет заказ в статус `SHIPPED`; * при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/items

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/items" \
 -d '{
  "reason" : "PARTNER_REQUESTED_REMOVE",
  "items" : [ {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  }, {
    "instances" : [ {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    }, {
      "rnpt" : "rnpt",
      "gtd" : "gtd",
      "uin" : "uin",
      "cis" : "cis"
    } ],
    "count" : 0,
    "id" : 0
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderItemRequest updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

try {
    final result = await api_instance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderItems: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderItemRequest updateOrderItemRequest = ; // UpdateOrderItemRequest | 

        try {
            apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderItemRequest *updateOrderItemRequest = ; // 

// Удаление товара из заказа или уменьшение числа единиц
[apiInstance updateOrderItemsWith:campaignId
    orderId:orderId
    updateOrderItemRequest:updateOrderItemRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderItemRequest = ; // {UpdateOrderItemRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrderItems(campaignId, orderId, updateOrderItemRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderItemsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderItemRequest = new UpdateOrderItemRequest(); // UpdateOrderItemRequest | 

            try {
                // Удаление товара из заказа или уменьшение числа единиц
                apiInstance.updateOrderItems(campaignId, orderId, updateOrderItemRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.updateOrderItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderItemRequest = ; // UpdateOrderItemRequest | 

try {
    $api_instance->updateOrderItems($campaignId, $orderId, $updateOrderItemRequest);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderItemRequest = WWW::OPenAPIClient::Object::UpdateOrderItemRequest->new(); # UpdateOrderItemRequest | 

eval {
    $api_instance->updateOrderItems(campaignId => $campaignId, orderId => $orderId, updateOrderItemRequest => $updateOrderItemRequest);
};
if ($@) {
    warn "Exception when calling OrdersApi->updateOrderItems: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderItemRequest =  # UpdateOrderItemRequest | 

try:
    # Удаление товара из заказа или уменьшение числа единиц
    api_instance.update_order_items(campaignId, orderId, updateOrderItemRequest)
except ApiException as e:
    print("Exception when calling OrdersApi->updateOrderItems: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderItemRequest = ; // UpdateOrderItemRequest

    let mut context = OrdersApi::Context::default();
    let result = client.updateOrderItems(campaignId, orderId, updateOrderItemRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderItemRequest *

Responses


updateOrderStatus

Изменение статуса одного заказа

Изменяет статус заказа. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/status

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/status" \
 -d '{
  "order" : {
    "delivery" : {
      "dates" : {
        "realDeliveryDate" : "2000-01-23"
      }
    },
    "substatus" : "RESERVATION_EXPIRED",
    "status" : "PLACING"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final UpdateOrderStatusRequest updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

try {
    final result = await api_instance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatus: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        UpdateOrderStatusRequest updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

        try {
            UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
UpdateOrderStatusRequest *updateOrderStatusRequest = ; // 

// Изменение статуса одного заказа
[apiInstance updateOrderStatusWith:campaignId
    orderId:orderId
    updateOrderStatusRequest:updateOrderStatusRequest
              completionHandler: ^(UpdateOrderStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var updateOrderStatusRequest = ; // {UpdateOrderStatusRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var updateOrderStatusRequest = new UpdateOrderStatusRequest(); // UpdateOrderStatusRequest | 

            try {
                // Изменение статуса одного заказа
                UpdateOrderStatusResponse result = apiInstance.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.updateOrderStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$updateOrderStatusRequest = ; // UpdateOrderStatusRequest | 

try {
    $result = $api_instance->updateOrderStatus($campaignId, $orderId, $updateOrderStatusRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->updateOrderStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $updateOrderStatusRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusRequest->new(); # UpdateOrderStatusRequest | 

eval {
    my $result = $api_instance->updateOrderStatus(campaignId => $campaignId, orderId => $orderId, updateOrderStatusRequest => $updateOrderStatusRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->updateOrderStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
updateOrderStatusRequest =  # UpdateOrderStatusRequest | 

try:
    # Изменение статуса одного заказа
    api_response = api_instance.update_order_status(campaignId, orderId, updateOrderStatusRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->updateOrderStatus: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let updateOrderStatusRequest = ; // UpdateOrderStatusRequest

    let mut context = OrdersApi::Context::default();
    let result = client.updateOrderStatus(campaignId, orderId, updateOrderStatusRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
Body parameters
Name Description
updateOrderStatusRequest *

Responses


updateOrderStatuses

Изменение статусов нескольких заказов

Изменяет статусы нескольких заказов. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса `"status": "PROCESSING"`и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "PROCESSING"` и этап обработки `"substatus": "READY_TO_SHIP"`. * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "STARTED"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса `"status": "PROCESSING"` и этапа обработки `"substatus": "READY_TO_SHIP"` нужно перевести в статус `"status": "CANCELLED"` с причиной отмены заказа `"substatus": "SHOP_FAILED"`. Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/orders/status-update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/status-update" \
 -d '{
  "orders" : [ {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  }, {
    "substatus" : "RESERVATION_EXPIRED",
    "id" : 0,
    "status" : "PLACING"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOrderStatusesRequest updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

try {
    final result = await api_instance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOrderStatuses: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOrderStatusesRequest updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

        try {
            UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#updateOrderStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOrderStatusesRequest *updateOrderStatusesRequest = ; // 

// Изменение статусов нескольких заказов
[apiInstance updateOrderStatusesWith:campaignId
    updateOrderStatusesRequest:updateOrderStatusesRequest
              completionHandler: ^(UpdateOrderStatusesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOrderStatusesRequest = ; // {UpdateOrderStatusesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrderStatuses(campaignId, updateOrderStatusesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOrderStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOrderStatusesRequest = new UpdateOrderStatusesRequest(); // UpdateOrderStatusesRequest | 

            try {
                // Изменение статусов нескольких заказов
                UpdateOrderStatusesResponse result = apiInstance.updateOrderStatuses(campaignId, updateOrderStatusesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.updateOrderStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest | 

try {
    $result = $api_instance->updateOrderStatuses($campaignId, $updateOrderStatusesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->updateOrderStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOrderStatusesRequest = WWW::OPenAPIClient::Object::UpdateOrderStatusesRequest->new(); # UpdateOrderStatusesRequest | 

eval {
    my $result = $api_instance->updateOrderStatuses(campaignId => $campaignId, updateOrderStatusesRequest => $updateOrderStatusesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->updateOrderStatuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOrderStatusesRequest =  # UpdateOrderStatusesRequest | 

try:
    # Изменение статусов нескольких заказов
    api_response = api_instance.update_order_statuses(campaignId, updateOrderStatusesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->updateOrderStatuses: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOrderStatusesRequest = ; // UpdateOrderStatusesRequest

    let mut context = OrdersApi::Context::default();
    let result = client.updateOrderStatuses(campaignId, updateOrderStatusesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOrderStatusesRequest *

Responses


OrdersStats

getOrdersStats

Детальная информация по заказам

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п. {% note info "" %} Раньше генерация детальной информации по заказам называлась **Отчет по заказам**. Сейчас это новый отчет. [Подробнее об отчете](../../reference/reports/generateUnitedOrdersReport.md) {% endnote %} В одном запросе можно получить информацию не более чем по 200 заказам. |**⚙️ Лимит:** 1 000 000 запросов в час| |-|


/campaigns/{campaignId}/stats/orders

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "updateTo" : "2000-01-23",
  "updateFrom" : "2000-01-23",
  "hasCis" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "CANCELLED_BEFORE_PROCESSING", "CANCELLED_BEFORE_PROCESSING" ],
  "orders" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersStatsApi;

import java.io.File;
import java.util.*;

public class OrdersStatsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OrdersStatsApi apiInstance = new OrdersStatsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersStatsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetOrdersStatsRequest getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest | 

try {
    final result = await api_instance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOrdersStats: $e\n');
}

import org.openapitools.client.api.OrdersStatsApi;

public class OrdersStatsApiExample {
    public static void main(String[] args) {
        OrdersStatsApi apiInstance = new OrdersStatsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetOrdersStatsRequest getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

        try {
            GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersStatsApi#getOrdersStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OrdersStatsApi *apiInstance = [[OrdersStatsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetOrdersStatsRequest *getOrdersStatsRequest = ; //  (optional)

// Детальная информация по заказам
[apiInstance getOrdersStatsWith:campaignId
    pageToken:pageToken
    limit:limit
    getOrdersStatsRequest:getOrdersStatsRequest
              completionHandler: ^(GetOrdersStatsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OrdersStatsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getOrdersStatsRequest':  // {GetOrdersStatsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrdersStats(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOrdersStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersStatsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getOrdersStatsRequest = new GetOrdersStatsRequest(); // GetOrdersStatsRequest |  (optional) 

            try {
                // Детальная информация по заказам
                GetOrdersStatsResponse result = apiInstance.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersStatsApi.getOrdersStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersStatsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getOrdersStatsRequest = ; // GetOrdersStatsRequest | 

try {
    $result = $api_instance->getOrdersStats($campaignId, $pageToken, $limit, $getOrdersStatsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersStatsApi->getOrdersStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersStatsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersStatsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getOrdersStatsRequest = WWW::OPenAPIClient::Object::GetOrdersStatsRequest->new(); # GetOrdersStatsRequest | 

eval {
    my $result = $api_instance->getOrdersStats(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getOrdersStatsRequest => $getOrdersStatsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersStatsApi->getOrdersStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersStatsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getOrdersStatsRequest =  # GetOrdersStatsRequest |  (optional)

try:
    # Детальная информация по заказам
    api_response = api_instance.get_orders_stats(campaignId, pageToken=pageToken, limit=limit, getOrdersStatsRequest=getOrdersStatsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersStatsApi->getOrdersStats: %s\n" % e)
extern crate OrdersStatsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getOrdersStatsRequest = ; // GetOrdersStatsRequest

    let mut context = OrdersStatsApi::Context::default();
    let result = client.getOrdersStats(campaignId, pageToken, limit, getOrdersStatsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getOrdersStatsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


OutletLicenses

deleteOutletLicenses

Удаление лицензий для точек продаж

Удаляет информацию о лицензиях для точек продаж. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses?ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletLicensesApi;

import java.io.File;
import java.util.*;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#deleteOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final set[Long] ids = new set[Long](); // set[Long] | Список идентификаторов лицензий.

try {
    final result = await api_instance.deleteOutletLicenses(campaignId, ids);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOutletLicenses: $e\n');
}

import org.openapitools.client.api.OutletLicensesApi;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#deleteOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletLicensesApi *apiInstance = [[OutletLicensesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
set[Long] *ids = ; // Список идентификаторов лицензий. (optional) (default to null)

// Удаление лицензий для точек продаж
[apiInstance deleteOutletLicensesWith:campaignId
    ids:ids
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletLicensesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'ids':  // {set[Long]} Список идентификаторов лицензий.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOutletLicenses(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletLicensesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var ids = new set[Long](); // set[Long] | Список идентификаторов лицензий. (optional)  (default to null)

            try {
                // Удаление лицензий для точек продаж
                EmptyApiResponse result = apiInstance.deleteOutletLicenses(campaignId, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletLicensesApi.deleteOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletLicensesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$ids = ; // set[Long] | Список идентификаторов лицензий.

try {
    $result = $api_instance->deleteOutletLicenses($campaignId, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletLicensesApi->deleteOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletLicensesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletLicensesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $ids = []; # set[Long] | Список идентификаторов лицензий.

eval {
    my $result = $api_instance->deleteOutletLicenses(campaignId => $campaignId, ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletLicensesApi->deleteOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletLicensesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ids =  # set[Long] | Список идентификаторов лицензий. (optional) (default to null)

try:
    # Удаление лицензий для точек продаж
    api_response = api_instance.delete_outlet_licenses(campaignId, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletLicensesApi->deleteOutletLicenses: %s\n" % e)
extern crate OutletLicensesApi;

pub fn main() {
    let campaignId = 789; // Long
    let ids = ; // set[Long]

    let mut context = OutletLicensesApi::Context::default();
    let result = client.deleteOutletLicenses(campaignId, ids, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
ids
set[Long] (int64)
Список идентификаторов лицензий.

Responses


getOutletLicenses

Информация о лицензиях для точек продаж

Возвращает информацию о лицензиях для точек продаж. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses?outletIds=&ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletLicensesApi;

import java.io.File;
import java.util.*;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#getOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final set[Long] outletIds = new set[Long](); // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

final set[Long] ids = new set[Long](); // set[Long] | Список идентификаторов лицензий.

try {
    final result = await api_instance.getOutletLicenses(campaignId, outletIds, ids);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutletLicenses: $e\n');
}

import org.openapitools.client.api.OutletLicensesApi;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        set[Long] outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

        set[Long] ids = ; // set[Long] | Список идентификаторов лицензий.

        try {
            GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#getOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletLicensesApi *apiInstance = [[OutletLicensesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
set[Long] *outletIds = ; // Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional) (default to null)
set[Long] *ids = ; // Список идентификаторов лицензий. (optional) (default to null)

// Информация о лицензиях для точек продаж
[apiInstance getOutletLicensesWith:campaignId
    outletIds:outletIds
    ids:ids
              completionHandler: ^(GetOutletLicensesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletLicensesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'outletIds': , // {set[Long]} Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

  'ids':  // {set[Long]} Список идентификаторов лицензий.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutletLicenses(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletLicensesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletIds = new set[Long](); // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional)  (default to null)
            var ids = new set[Long](); // set[Long] | Список идентификаторов лицензий. (optional)  (default to null)

            try {
                // Информация о лицензиях для точек продаж
                GetOutletLicensesResponse result = apiInstance.getOutletLicenses(campaignId, outletIds, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletLicensesApi.getOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletLicensesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletIds = ; // set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

$ids = ; // set[Long] | Список идентификаторов лицензий.

try {
    $result = $api_instance->getOutletLicenses($campaignId, $outletIds, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletLicensesApi->getOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletLicensesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletLicensesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletIds = []; # set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.

my $ids = []; # set[Long] | Список идентификаторов лицензий.

eval {
    my $result = $api_instance->getOutletLicenses(campaignId => $campaignId, outletIds => $outletIds, ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletLicensesApi->getOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletLicensesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletIds =  # set[Long] | Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
 (optional) (default to null)
ids =  # set[Long] | Список идентификаторов лицензий. (optional) (default to null)

try:
    # Информация о лицензиях для точек продаж
    api_response = api_instance.get_outlet_licenses(campaignId, outletIds=outletIds, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletLicensesApi->getOutletLicenses: %s\n" % e)
extern crate OutletLicensesApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletIds = ; // set[Long]
    let ids = ; // set[Long]

    let mut context = OutletLicensesApi::Context::default();
    let result = client.getOutletLicenses(campaignId, outletIds, ids, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
outletIds
set[Long] (int64)
Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую. В запросе должен быть либо параметр `outletIds`, либо параметр `ids`. Запрос с обоими параметрами или без них приведет к ошибке.
ids
set[Long] (int64)
Список идентификаторов лицензий.

Responses


updateOutletLicenses

Создание и изменение лицензий для точек продаж

Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя. Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/licenses

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses" \
 -d '{
  "licenses" : [ {
    "licenseType" : "ALCOHOL",
    "number" : "number",
    "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
    "outletId" : 6,
    "id" : 0,
    "dateOfIssue" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "licenseType" : "ALCOHOL",
    "number" : "number",
    "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
    "outletId" : 6,
    "id" : 0,
    "dateOfIssue" : "2000-01-23T04:56:07.000+00:00"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletLicensesApi;

import java.io.File;
import java.util.*;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOutletLicenseRequest updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#updateOutletLicenses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateOutletLicenseRequest updateOutletLicenseRequest = new UpdateOutletLicenseRequest(); // UpdateOutletLicenseRequest | 

try {
    final result = await api_instance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOutletLicenses: $e\n');
}

import org.openapitools.client.api.OutletLicensesApi;

public class OutletLicensesApiExample {
    public static void main(String[] args) {
        OutletLicensesApi apiInstance = new OutletLicensesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateOutletLicenseRequest updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletLicensesApi#updateOutletLicenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletLicensesApi *apiInstance = [[OutletLicensesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateOutletLicenseRequest *updateOutletLicenseRequest = ; // 

// Создание и изменение лицензий для точек продаж
[apiInstance updateOutletLicensesWith:campaignId
    updateOutletLicenseRequest:updateOutletLicenseRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletLicensesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateOutletLicenseRequest = ; // {UpdateOutletLicenseRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOutletLicenses(campaignId, updateOutletLicenseRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOutletLicensesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletLicensesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateOutletLicenseRequest = new UpdateOutletLicenseRequest(); // UpdateOutletLicenseRequest | 

            try {
                // Создание и изменение лицензий для точек продаж
                EmptyApiResponse result = apiInstance.updateOutletLicenses(campaignId, updateOutletLicenseRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletLicensesApi.updateOutletLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletLicensesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest | 

try {
    $result = $api_instance->updateOutletLicenses($campaignId, $updateOutletLicenseRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletLicensesApi->updateOutletLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletLicensesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletLicensesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateOutletLicenseRequest = WWW::OPenAPIClient::Object::UpdateOutletLicenseRequest->new(); # UpdateOutletLicenseRequest | 

eval {
    my $result = $api_instance->updateOutletLicenses(campaignId => $campaignId, updateOutletLicenseRequest => $updateOutletLicenseRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletLicensesApi->updateOutletLicenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletLicensesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateOutletLicenseRequest =  # UpdateOutletLicenseRequest | 

try:
    # Создание и изменение лицензий для точек продаж
    api_response = api_instance.update_outlet_licenses(campaignId, updateOutletLicenseRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletLicensesApi->updateOutletLicenses: %s\n" % e)
extern crate OutletLicensesApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateOutletLicenseRequest = ; // UpdateOutletLicenseRequest

    let mut context = OutletLicensesApi::Context::default();
    let result = client.updateOutletLicenses(campaignId, updateOutletLicenseRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateOutletLicenseRequest *

Responses


Outlets

createOutlet

Создание точки продаж

Создает точку продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets" \
 -d '{
  "storagePeriod" : 0,
  "address" : {
    "number" : "number",
    "km" : 6,
    "regionId" : 0,
    "city" : "city",
    "street" : "street",
    "additional" : "additional",
    "estate" : "estate",
    "block" : "block",
    "building" : "building"
  },
  "visibility" : "HIDDEN",
  "isMain" : true,
  "shopOutletCode" : "shopOutletCode",
  "name" : "name",
  "phones" : [ "phones", "phones" ],
  "type" : "DEPOT",
  "coords" : "coords",
  "workingSchedule" : {
    "scheduleItems" : [ {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    }, {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    } ],
    "workInHoliday" : true
  },
  "deliveryRules" : [ {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  }, {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletsApi;

import java.io.File;
import java.util.*;

public class OutletsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#createOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ChangeOutletRequest changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

try {
    final result = await api_instance.createOutlet(campaignId, changeOutletRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createOutlet: $e\n');
}

import org.openapitools.client.api.OutletsApi;

public class OutletsApiExample {
    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#createOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletsApi *apiInstance = [[OutletsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ChangeOutletRequest *changeOutletRequest = ; // 

// Создание точки продаж
[apiInstance createOutletWith:campaignId
    changeOutletRequest:changeOutletRequest
              completionHandler: ^(CreateOutletResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var changeOutletRequest = ; // {ChangeOutletRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOutlet(campaignId, changeOutletRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class createOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

            try {
                // Создание точки продаж
                CreateOutletResponse result = apiInstance.createOutlet(campaignId, changeOutletRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletsApi.createOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$changeOutletRequest = ; // ChangeOutletRequest | 

try {
    $result = $api_instance->createOutlet($campaignId, $changeOutletRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->createOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $changeOutletRequest = WWW::OPenAPIClient::Object::ChangeOutletRequest->new(); # ChangeOutletRequest | 

eval {
    my $result = $api_instance->createOutlet(campaignId => $campaignId, changeOutletRequest => $changeOutletRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletsApi->createOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
changeOutletRequest =  # ChangeOutletRequest | 

try:
    # Создание точки продаж
    api_response = api_instance.create_outlet(campaignId, changeOutletRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletsApi->createOutlet: %s\n" % e)
extern crate OutletsApi;

pub fn main() {
    let campaignId = 789; // Long
    let changeOutletRequest = ; // ChangeOutletRequest

    let mut context = OutletsApi::Context::default();
    let result = client.createOutlet(campaignId, changeOutletRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
changeOutletRequest *

Responses


deleteOutlet

Удаление точки продаж

Удаляет точку продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletsApi;

import java.io.File;
import java.util.*;

public class OutletsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#deleteOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.

try {
    final result = await api_instance.deleteOutlet(campaignId, outletId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteOutlet: $e\n');
}

import org.openapitools.client.api.OutletsApi;

public class OutletsApiExample {
    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#deleteOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletsApi *apiInstance = [[OutletsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)

// Удаление точки продаж
[apiInstance deleteOutletWith:campaignId
    outletId:outletId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOutlet(campaignId, outletId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deleteOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)

            try {
                // Удаление точки продаж
                EmptyApiResponse result = apiInstance.deleteOutlet(campaignId, outletId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletsApi.deleteOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.

try {
    $result = $api_instance->deleteOutlet($campaignId, $outletId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->deleteOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.

eval {
    my $result = $api_instance->deleteOutlet(campaignId => $campaignId, outletId => $outletId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletsApi->deleteOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)

try:
    # Удаление точки продаж
    api_response = api_instance.delete_outlet(campaignId, outletId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletsApi->deleteOutlet: %s\n" % e)
extern crate OutletsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long

    let mut context = OutletsApi::Context::default();
    let result = client.deleteOutlet(campaignId, outletId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required

Responses


getOutlet

Информация об одной точке продаж

Возвращает информацию о точках продаж магазина. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletsApi;

import java.io.File;
import java.util.*;

public class OutletsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#getOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.

try {
    final result = await api_instance.getOutlet(campaignId, outletId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutlet: $e\n');
}

import org.openapitools.client.api.OutletsApi;

public class OutletsApiExample {
    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.

        try {
            GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#getOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletsApi *apiInstance = [[OutletsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)

// Информация об одной точке продаж
[apiInstance getOutletWith:campaignId
    outletId:outletId
              completionHandler: ^(GetOutletResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutlet(campaignId, outletId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)

            try {
                // Информация об одной точке продаж
                GetOutletResponse result = apiInstance.getOutlet(campaignId, outletId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletsApi.getOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.

try {
    $result = $api_instance->getOutlet($campaignId, $outletId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->getOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.

eval {
    my $result = $api_instance->getOutlet(campaignId => $campaignId, outletId => $outletId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletsApi->getOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)

try:
    # Информация об одной точке продаж
    api_response = api_instance.get_outlet(campaignId, outletId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletsApi->getOutlet: %s\n" % e)
extern crate OutletsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long

    let mut context = OutletsApi::Context::default();
    let result = client.getOutlet(campaignId, outletId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required

Responses


getOutlets

Информация о нескольких точках продаж

Возвращает список точек продаж магазина. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==®ion_id=789&shop_outlet_code=shopOutletCode_example®ionId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletsApi;

import java.io.File;
import java.util.*;

public class OutletsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Long regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

        String shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
        Long regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


        try {
            GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#getOutlets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Long regionId = new Long(); // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

final String shopOutletCode = new String(); // String | Идентификатор точки продаж, присвоенный магазином.
final Long regionId2 = new Long(); // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


try {
    final result = await api_instance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getOutlets: $e\n');
}

import org.openapitools.client.api.OutletsApi;

public class OutletsApiExample {
    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Long regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

        String shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
        Long regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


        try {
            GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#getOutlets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletsApi *apiInstance = [[OutletsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Long *regionId = 789; // Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional) (default to null)
String *shopOutletCode = shopOutletCode_example; // Идентификатор точки продаж, присвоенный магазином. (optional) (default to null)
Long *regionId2 = 789; // {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional) (default to null)

// Информация о нескольких точках продаж
[apiInstance getOutletsWith:campaignId
    pageToken:pageToken
    regionId:regionId
    shopOutletCode:shopOutletCode
    regionId2:regionId2
              completionHandler: ^(GetOutletsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'regionId': 789, // {Long} Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

  'shopOutletCode': shopOutletCode_example, // {String} Идентификатор точки продаж, присвоенный магазином.
  'regionId2': 789 // {Long} {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutlets(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getOutletsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var regionId = 789;  // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional)  (default to null)
            var shopOutletCode = shopOutletCode_example;  // String | Идентификатор точки продаж, присвоенный магазином. (optional)  (default to null)
            var regionId2 = 789;  // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional)  (default to null)

            try {
                // Информация о нескольких точках продаж
                GetOutletsResponse result = apiInstance.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletsApi.getOutlets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$regionId = 789; // Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

$shopOutletCode = shopOutletCode_example; // String | Идентификатор точки продаж, присвоенный магазином.
$regionId2 = 789; // Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


try {
    $result = $api_instance->getOutlets($campaignId, $pageToken, $regionId, $shopOutletCode, $regionId2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->getOutlets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $regionId = 789; # Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).

my $shopOutletCode = shopOutletCode_example; # String | Идентификатор точки продаж, присвоенный магазином.
my $regionId2 = 789; # Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}


eval {
    my $result = $api_instance->getOutlets(campaignId => $campaignId, pageToken => $pageToken, regionId => $regionId, shopOutletCode => $shopOutletCode, regionId2 => $regionId2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletsApi->getOutlets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
regionId = 789 # Long | Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
 (optional) (default to null)
shopOutletCode = shopOutletCode_example # String | Идентификатор точки продаж, присвоенный магазином. (optional) (default to null)
regionId2 = 789 # Long | {% note warning "" %}

Этот параметр устарел. Для указания региона используйте `region_id`.

{% endnote %}
 (optional) (default to null)

try:
    # Информация о нескольких точках продаж
    api_response = api_instance.get_outlets(campaignId, pageToken=pageToken, regionId=regionId, shopOutletCode=shopOutletCode, regionId2=regionId2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletsApi->getOutlets: %s\n" % e)
extern crate OutletsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let regionId = 789; // Long
    let shopOutletCode = shopOutletCode_example; // String
    let regionId2 = 789; // Long

    let mut context = OutletsApi::Context::default();
    let result = client.getOutlets(campaignId, pageToken, regionId, shopOutletCode, regionId2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
region_id
Long (int64)
Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода [GET regions](../../reference/regions/searchRegionsByName.md).
shop_outlet_code
String
Идентификатор точки продаж, присвоенный магазином.
regionId
Long (int64)
{% note warning "" %} Этот параметр устарел. Для указания региона используйте `region_id`. {% endnote %}

Responses


updateOutlet

Изменение информации о точке продаж

Изменяет информацию о точке продаж магазина на Маркете. В течение суток этим и другими запросами о точках продаж, кроме запроса [GET delivery/services](../../reference/orders/getDeliveryServices.md), можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина. |**⚙️ Лимит:** 100 000 запросов в час| |-|


/campaigns/{campaignId}/outlets/{outletId}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/{outletId}" \
 -d '{
  "storagePeriod" : 0,
  "address" : {
    "number" : "number",
    "km" : 6,
    "regionId" : 0,
    "city" : "city",
    "street" : "street",
    "additional" : "additional",
    "estate" : "estate",
    "block" : "block",
    "building" : "building"
  },
  "visibility" : "HIDDEN",
  "isMain" : true,
  "shopOutletCode" : "shopOutletCode",
  "name" : "name",
  "phones" : [ "phones", "phones" ],
  "type" : "DEPOT",
  "coords" : "coords",
  "workingSchedule" : {
    "scheduleItems" : [ {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    }, {
      "startDay" : "MONDAY",
      "startTime" : "startTime",
      "endTime" : "endTime"
    } ],
    "workInHoliday" : true
  },
  "deliveryRules" : [ {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  }, {
    "priceFreePickup" : 7.061401241503109,
    "deliveryServiceId" : 5,
    "maxDeliveryDays" : 5,
    "minDeliveryDays" : 1,
    "orderBefore" : 5,
    "unspecifiedDeliveryInterval" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OutletsApi;

import java.io.File;
import java.util.*;

public class OutletsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.
        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#updateOutlet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long outletId = new Long(); // Long | Идентификатор точки продаж.
final ChangeOutletRequest changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

try {
    final result = await api_instance.updateOutlet(campaignId, outletId, changeOutletRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOutlet: $e\n');
}

import org.openapitools.client.api.OutletsApi;

public class OutletsApiExample {
    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long outletId = 789; // Long | Идентификатор точки продаж.
        ChangeOutletRequest changeOutletRequest = ; // ChangeOutletRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#updateOutlet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OutletsApi *apiInstance = [[OutletsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *outletId = 789; // Идентификатор точки продаж. (default to null)
ChangeOutletRequest *changeOutletRequest = ; // 

// Изменение информации о точке продаж
[apiInstance updateOutletWith:campaignId
    outletId:outletId
    changeOutletRequest:changeOutletRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.OutletsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var outletId = 789; // {Long} Идентификатор точки продаж.
var changeOutletRequest = ; // {ChangeOutletRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOutlet(campaignId, outletId, changeOutletRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateOutletExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OutletsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var outletId = 789;  // Long | Идентификатор точки продаж. (default to null)
            var changeOutletRequest = new ChangeOutletRequest(); // ChangeOutletRequest | 

            try {
                // Изменение информации о точке продаж
                EmptyApiResponse result = apiInstance.updateOutlet(campaignId, outletId, changeOutletRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OutletsApi.updateOutlet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OutletsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$outletId = 789; // Long | Идентификатор точки продаж.
$changeOutletRequest = ; // ChangeOutletRequest | 

try {
    $result = $api_instance->updateOutlet($campaignId, $outletId, $changeOutletRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->updateOutlet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OutletsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OutletsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $outletId = 789; # Long | Идентификатор точки продаж.
my $changeOutletRequest = WWW::OPenAPIClient::Object::ChangeOutletRequest->new(); # ChangeOutletRequest | 

eval {
    my $result = $api_instance->updateOutlet(campaignId => $campaignId, outletId => $outletId, changeOutletRequest => $changeOutletRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutletsApi->updateOutlet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OutletsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
outletId = 789 # Long | Идентификатор точки продаж. (default to null)
changeOutletRequest =  # ChangeOutletRequest | 

try:
    # Изменение информации о точке продаж
    api_response = api_instance.update_outlet(campaignId, outletId, changeOutletRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutletsApi->updateOutlet: %s\n" % e)
extern crate OutletsApi;

pub fn main() {
    let campaignId = 789; // Long
    let outletId = 789; // Long
    let changeOutletRequest = ; // ChangeOutletRequest

    let mut context = OutletsApi::Context::default();
    let result = client.updateOutlet(campaignId, outletId, changeOutletRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
outletId*
Long (int64)
Идентификатор точки продаж.
Required
Body parameters
Name Description
changeOutletRequest *

Responses


PriceQuarantine

confirmBusinessPrices

Удаление товара из карантина по цене в кабинете

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина. Основная цена задается в каталоге и действует во всех магазинах кабинета. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST businesses/{businessId}/price-quarantine](getBusinessQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PriceQuarantineApi;

import java.io.File;
import java.util.*;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmBusinessPrices(businessId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmBusinessPrices: $e\n');
}

import org.openapitools.client.api.PriceQuarantineApi;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#confirmBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PriceQuarantineApi *apiInstance = [[PriceQuarantineApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в кабинете
[apiInstance confirmBusinessPricesWith:businessId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PriceQuarantineApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmBusinessPrices(businessId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PriceQuarantineApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в кабинете
                EmptyApiResponse result = apiInstance.confirmBusinessPrices(businessId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PriceQuarantineApi.confirmBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PriceQuarantineApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmBusinessPrices($businessId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PriceQuarantineApi->confirmBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PriceQuarantineApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PriceQuarantineApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmBusinessPrices(businessId => $businessId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PriceQuarantineApi->confirmBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PriceQuarantineApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в кабинете
    api_response = api_instance.confirm_business_prices(businessId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PriceQuarantineApi->confirmBusinessPrices: %s\n" % e)
extern crate PriceQuarantineApi;

pub fn main() {
    let businessId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = PriceQuarantineApi::Context::default();
    let result = client.confirmBusinessPrices(businessId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


confirmCampaignPrices

Удаление товара из карантина по цене в магазине

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина. Товар попадает в карантин, если его цена меняется слишком резко. [Как настроить карантин](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) Чтобы увидеть список товаров, которые попали в карантин, используйте запрос [POST campaigns/{campaignId}/price-quarantine](getCampaignQuarantineOffers.md). |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine/confirm" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PriceQuarantineApi;

import java.io.File;
import java.util.*;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final ConfirmPricesRequest confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

try {
    final result = await api_instance.confirmCampaignPrices(campaignId, confirmPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmCampaignPrices: $e\n');
}

import org.openapitools.client.api.PriceQuarantineApi;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        ConfirmPricesRequest confirmPricesRequest = ; // ConfirmPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#confirmCampaignPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PriceQuarantineApi *apiInstance = [[PriceQuarantineApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
ConfirmPricesRequest *confirmPricesRequest = ; // 

// Удаление товара из карантина по цене в магазине
[apiInstance confirmCampaignPricesWith:campaignId
    confirmPricesRequest:confirmPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PriceQuarantineApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var confirmPricesRequest = ; // {ConfirmPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmCampaignPrices(campaignId, confirmPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmCampaignPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PriceQuarantineApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var confirmPricesRequest = new ConfirmPricesRequest(); // ConfirmPricesRequest | 

            try {
                // Удаление товара из карантина по цене в магазине
                EmptyApiResponse result = apiInstance.confirmCampaignPrices(campaignId, confirmPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PriceQuarantineApi.confirmCampaignPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PriceQuarantineApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$confirmPricesRequest = ; // ConfirmPricesRequest | 

try {
    $result = $api_instance->confirmCampaignPrices($campaignId, $confirmPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PriceQuarantineApi->confirmCampaignPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PriceQuarantineApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PriceQuarantineApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $confirmPricesRequest = WWW::OPenAPIClient::Object::ConfirmPricesRequest->new(); # ConfirmPricesRequest | 

eval {
    my $result = $api_instance->confirmCampaignPrices(campaignId => $campaignId, confirmPricesRequest => $confirmPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PriceQuarantineApi->confirmCampaignPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PriceQuarantineApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
confirmPricesRequest =  # ConfirmPricesRequest | 

try:
    # Удаление товара из карантина по цене в магазине
    api_response = api_instance.confirm_campaign_prices(campaignId, confirmPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PriceQuarantineApi->confirmCampaignPrices: %s\n" % e)
extern crate PriceQuarantineApi;

pub fn main() {
    let campaignId = 789; // Long
    let confirmPricesRequest = ; // ConfirmPricesRequest

    let mut context = PriceQuarantineApi::Context::default();
    let result = client.confirmCampaignPrices(campaignId, confirmPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
confirmPricesRequest *

Responses


getBusinessQuarantineOffers

Список товаров, находящихся в карантине по цене в кабинете

Возвращает список товаров, которые находятся в карантине по **основной цене**. Основная цена задается в каталоге и действует во всех магазинах кабинета. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST businesses/{businessId}/price-quarantine/confirm](../../reference/business-assortment/confirmBusinessPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PriceQuarantineApi;

import java.io.File;
import java.util.*;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessQuarantineOffers: $e\n');
}

import org.openapitools.client.api.PriceQuarantineApi;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#getBusinessQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PriceQuarantineApi *apiInstance = [[PriceQuarantineApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в кабинете
[apiInstance getBusinessQuarantineOffersWith:businessId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PriceQuarantineApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getBusinessQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PriceQuarantineApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в кабинете
                GetQuarantineOffersResponse result = apiInstance.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PriceQuarantineApi.getBusinessQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PriceQuarantineApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getBusinessQuarantineOffers($businessId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PriceQuarantineApi->getBusinessQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PriceQuarantineApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PriceQuarantineApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getBusinessQuarantineOffers(businessId => $businessId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PriceQuarantineApi->getBusinessQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PriceQuarantineApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в кабинете
    api_response = api_instance.get_business_quarantine_offers(businessId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PriceQuarantineApi->getBusinessQuarantineOffers: %s\n" % e)
extern crate PriceQuarantineApi;

pub fn main() {
    let businessId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = PriceQuarantineApi::Context::default();
    let result = client.getBusinessQuarantineOffers(businessId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getCampaignQuarantineOffers

Список товаров, находящихся в карантине по цене в магазине

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине. Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса [POST campaigns/{campaignId}/price-quarantine/confirm](../../reference/assortment/confirmCampaignPrices.md). Если цена в самом деле ошибочная, установите верную с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md). {% note info "𝓠 Что такое карантин?" %} 𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. [Подробнее](https://yandex.ru/support/marketplace/assortment/operations/prices.html#quarantine) {% endnote %} В запросе можно использовать фильтры. Результаты возвращаются постранично. |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/price-quarantine

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "categoryIds" : [ 0, 0 ],
  "vendorNames" : [ "vendorNames", "vendorNames" ],
  "offerIds" : [ null, null, null, null, null ],
  "cardStatuses" : [ "HAS_CARD_CAN_NOT_UPDATE", "HAS_CARD_CAN_NOT_UPDATE" ],
  "tags" : [ "tags", "tags" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PriceQuarantineApi;

import java.io.File;
import java.util.*;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQuarantineOffersRequest getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCampaignQuarantineOffers: $e\n');
}

import org.openapitools.client.api.PriceQuarantineApi;

public class PriceQuarantineApiExample {
    public static void main(String[] args) {
        PriceQuarantineApi apiInstance = new PriceQuarantineApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQuarantineOffersRequest getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PriceQuarantineApi#getCampaignQuarantineOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PriceQuarantineApi *apiInstance = [[PriceQuarantineApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQuarantineOffersRequest *getQuarantineOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Список товаров, находящихся в карантине по цене в магазине
[apiInstance getCampaignQuarantineOffersWith:campaignId
    getQuarantineOffersRequest:getQuarantineOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetQuarantineOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PriceQuarantineApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQuarantineOffersRequest = ; // {GetQuarantineOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getCampaignQuarantineOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PriceQuarantineApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQuarantineOffersRequest = new GetQuarantineOffersRequest(); // GetQuarantineOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Список товаров, находящихся в карантине по цене в магазине
                GetQuarantineOffersResponse result = apiInstance.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PriceQuarantineApi.getCampaignQuarantineOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PriceQuarantineApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQuarantineOffersRequest = ; // GetQuarantineOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getCampaignQuarantineOffers($campaignId, $getQuarantineOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PriceQuarantineApi->getCampaignQuarantineOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PriceQuarantineApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PriceQuarantineApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQuarantineOffersRequest = WWW::OPenAPIClient::Object::GetQuarantineOffersRequest->new(); # GetQuarantineOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getCampaignQuarantineOffers(campaignId => $campaignId, getQuarantineOffersRequest => $getQuarantineOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PriceQuarantineApi->getCampaignQuarantineOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PriceQuarantineApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQuarantineOffersRequest =  # GetQuarantineOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Список товаров, находящихся в карантине по цене в магазине
    api_response = api_instance.get_campaign_quarantine_offers(campaignId, getQuarantineOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PriceQuarantineApi->getCampaignQuarantineOffers: %s\n" % e)
extern crate PriceQuarantineApi;

pub fn main() {
    let campaignId = 789; // Long
    let getQuarantineOffersRequest = ; // GetQuarantineOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = PriceQuarantineApi::Context::default();
    let result = client.getCampaignQuarantineOffers(campaignId, getQuarantineOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQuarantineOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


Prices

getPrices

Список цен

{% note warning "" %} Этот метод устарел. Вместо него используйте [POST campaigns/{campaignId}/offer-prices](../../reference/assortment/getPricesByOfferIds.md). {% endnote %} Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом. {% note info %} Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов. {% endnote %} Способы установки цен описаны [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/assortment/operations/prices.html). |**⚙️ Лимит:** ```(количество товаров партнера на витрине) * 25``` товаров в сутки| |-|


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&archived=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PricesApi;

import java.io.File;
import java.util.*;

public class PricesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final Boolean archived = new Boolean(); // Boolean | Фильтр по нахождению в архиве.

try {
    final result = await api_instance.getPrices(campaignId, pageToken, limit, archived);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPrices: $e\n');
}

import org.openapitools.client.api.PricesApi;

public class PricesApiExample {
    public static void main(String[] args) {
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        Boolean archived = true; // Boolean | Фильтр по нахождению в архиве.

        try {
            GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PricesApi *apiInstance = [[PricesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
Boolean *archived = true; // Фильтр по нахождению в архиве. (optional) (default to false)

// Список цен
[apiInstance getPricesWith:campaignId
    pageToken:pageToken
    limit:limit
    archived:archived
              completionHandler: ^(GetPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PricesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'archived': true // {Boolean} Фильтр по нахождению в архиве.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrices(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PricesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var archived = true;  // Boolean | Фильтр по нахождению в архиве. (optional)  (default to false)

            try {
                // Список цен
                GetPricesResponse result = apiInstance.getPrices(campaignId, pageToken, limit, archived);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PricesApi.getPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PricesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$archived = true; // Boolean | Фильтр по нахождению в архиве.

try {
    $result = $api_instance->getPrices($campaignId, $pageToken, $limit, $archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricesApi->getPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PricesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PricesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $archived = true; # Boolean | Фильтр по нахождению в архиве.

eval {
    my $result = $api_instance->getPrices(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, archived => $archived);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PricesApi->getPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PricesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
archived = true # Boolean | Фильтр по нахождению в архиве. (optional) (default to false)

try:
    # Список цен
    api_response = api_instance.get_prices(campaignId, pageToken=pageToken, limit=limit, archived=archived)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PricesApi->getPrices: %s\n" % e)
extern crate PricesApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let archived = true; // Boolean

    let mut context = PricesApi::Context::default();
    let result = client.getPrices(campaignId, pageToken, limit, archived, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
archived
Boolean
Фильтр по нахождению в архиве.

Responses


getPricesByOfferIds

Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине. {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для просмотра базовых цен используйте [POST businesses/{businessId}/offer-mappings](../../reference/business-assortment/getOfferMappings.md). {% endnote %} |**⚙️ Лимит:** рассчитывается по [формуле](*rule)| |-| [//]: <> (rule: суточный лимит товаров — количество товаров на витрине * 25)


/campaigns/{campaignId}/offer-prices

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PricesApi;

import java.io.File;
import java.util.*;

public class PricesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest | 

try {
    final result = await api_instance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPricesByOfferIds: $e\n');
}

import org.openapitools.client.api.PricesApi;

public class PricesApiExample {
    public static void main(String[] args) {
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetPricesByOfferIdsRequest getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

        try {
            GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getPricesByOfferIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PricesApi *apiInstance = [[PricesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetPricesByOfferIdsRequest *getPricesByOfferIdsRequest = ; //  (optional)

// Просмотр цен на указанные товары в магазине
[apiInstance getPricesByOfferIdsWith:campaignId
    pageToken:pageToken
    limit:limit
    getPricesByOfferIdsRequest:getPricesByOfferIdsRequest
              completionHandler: ^(GetPricesByOfferIdsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PricesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getPricesByOfferIdsRequest':  // {GetPricesByOfferIdsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPricesByOfferIds(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPricesByOfferIdsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PricesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getPricesByOfferIdsRequest = new GetPricesByOfferIdsRequest(); // GetPricesByOfferIdsRequest |  (optional) 

            try {
                // Просмотр цен на указанные товары в магазине
                GetPricesByOfferIdsResponse result = apiInstance.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PricesApi.getPricesByOfferIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PricesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest | 

try {
    $result = $api_instance->getPricesByOfferIds($campaignId, $pageToken, $limit, $getPricesByOfferIdsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricesApi->getPricesByOfferIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PricesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PricesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getPricesByOfferIdsRequest = WWW::OPenAPIClient::Object::GetPricesByOfferIdsRequest->new(); # GetPricesByOfferIdsRequest | 

eval {
    my $result = $api_instance->getPricesByOfferIds(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getPricesByOfferIdsRequest => $getPricesByOfferIdsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PricesApi->getPricesByOfferIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PricesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getPricesByOfferIdsRequest =  # GetPricesByOfferIdsRequest |  (optional)

try:
    # Просмотр цен на указанные товары в магазине
    api_response = api_instance.get_prices_by_offer_ids(campaignId, pageToken=pageToken, limit=limit, getPricesByOfferIdsRequest=getPricesByOfferIdsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PricesApi->getPricesByOfferIds: %s\n" % e)
extern crate PricesApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getPricesByOfferIdsRequest = ; // GetPricesByOfferIdsRequest

    let mut context = PricesApi::Context::default();
    let result = client.getPricesByOfferIds(campaignId, pageToken, limit, getPricesByOfferIdsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPricesByOfferIdsRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getSuggestedPrices

Цены для продвижения товаров

{% note warning "" %} Этот метод устарел. Вместо него используйте [отчет «Цены на рынке»](../../reference/reports/generatePricesReport.md). {% endnote %} {% note warning "" %} Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях. {% endnote %} Возвращает цены для продвижения товаров, которые вы размещаете на Маркете. Товары, для которых нужно получить цены, передаются в теле POST-запроса. Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене. Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения. Установить цены на товары можно с помощью запроса [POST campaigns/{campaignId}/offer-prices/updates](../../reference/assortment/updatePrices.md) или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете. Подробно об автоматическом управлении ценами рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/marketing/prices.html). |**⚙️ Лимит:** 100 000 товаров в час| |-|


/campaigns/{campaignId}/offer-prices/suggestions

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions" \
 -d '{
  "offers" : [ {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  }, {
    "marketSku" : 0,
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PricesApi;

import java.io.File;
import java.util.*;

public class PricesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SuggestPricesRequest suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

try {
    final result = await api_instance.getSuggestedPrices(campaignId, suggestPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestedPrices: $e\n');
}

import org.openapitools.client.api.PricesApi;

public class PricesApiExample {
    public static void main(String[] args) {
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SuggestPricesRequest suggestPricesRequest = ; // SuggestPricesRequest | 

        try {
            SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#getSuggestedPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PricesApi *apiInstance = [[PricesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SuggestPricesRequest *suggestPricesRequest = ; // 

// Цены для продвижения товаров
[apiInstance getSuggestedPricesWith:campaignId
    suggestPricesRequest:suggestPricesRequest
              completionHandler: ^(SuggestPricesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PricesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var suggestPricesRequest = ; // {SuggestPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestedPrices(campaignId, suggestPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getSuggestedPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PricesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var suggestPricesRequest = new SuggestPricesRequest(); // SuggestPricesRequest | 

            try {
                // Цены для продвижения товаров
                SuggestPricesResponse result = apiInstance.getSuggestedPrices(campaignId, suggestPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PricesApi.getSuggestedPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PricesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$suggestPricesRequest = ; // SuggestPricesRequest | 

try {
    $result = $api_instance->getSuggestedPrices($campaignId, $suggestPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricesApi->getSuggestedPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PricesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PricesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $suggestPricesRequest = WWW::OPenAPIClient::Object::SuggestPricesRequest->new(); # SuggestPricesRequest | 

eval {
    my $result = $api_instance->getSuggestedPrices(campaignId => $campaignId, suggestPricesRequest => $suggestPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PricesApi->getSuggestedPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PricesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
suggestPricesRequest =  # SuggestPricesRequest | 

try:
    # Цены для продвижения товаров
    api_response = api_instance.get_suggested_prices(campaignId, suggestPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PricesApi->getSuggestedPrices: %s\n" % e)
extern crate PricesApi;

pub fn main() {
    let campaignId = 789; // Long
    let suggestPricesRequest = ; // SuggestPricesRequest

    let mut context = PricesApi::Context::default();
    let result = client.getSuggestedPrices(campaignId, suggestPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
suggestPricesRequest *

Responses


updateBusinessPrices

Установка цен на товары во всех магазинах

Устанавливает [базовые цены](*default-price). Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|


/businesses/{businessId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "discountBase" : 0.7061401241503109,
      "currencyId" : "RUR",
      "value" : 0.23021358869347652
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PricesApi;

import java.io.File;
import java.util.*;

public class PricesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PricesApi apiInstance = new PricesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateBusinessPricesRequest updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

try {
    final result = await api_instance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateBusinessPrices: $e\n');
}

import org.openapitools.client.api.PricesApi;

public class PricesApiExample {
    public static void main(String[] args) {
        PricesApi apiInstance = new PricesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateBusinessPricesRequest updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#updateBusinessPrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PricesApi *apiInstance = [[PricesApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateBusinessPricesRequest *updateBusinessPricesRequest = ; // 

// Установка цен на товары во всех магазинах
[apiInstance updateBusinessPricesWith:businessId
    updateBusinessPricesRequest:updateBusinessPricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PricesApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateBusinessPricesRequest = ; // {UpdateBusinessPricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBusinessPrices(businessId, updateBusinessPricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateBusinessPricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PricesApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateBusinessPricesRequest = new UpdateBusinessPricesRequest(); // UpdateBusinessPricesRequest | 

            try {
                // Установка цен на товары во всех магазинах
                EmptyApiResponse result = apiInstance.updateBusinessPrices(businessId, updateBusinessPricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PricesApi.updateBusinessPrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PricesApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest | 

try {
    $result = $api_instance->updateBusinessPrices($businessId, $updateBusinessPricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricesApi->updateBusinessPrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PricesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PricesApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateBusinessPricesRequest = WWW::OPenAPIClient::Object::UpdateBusinessPricesRequest->new(); # UpdateBusinessPricesRequest | 

eval {
    my $result = $api_instance->updateBusinessPrices(businessId => $businessId, updateBusinessPricesRequest => $updateBusinessPricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PricesApi->updateBusinessPrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PricesApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateBusinessPricesRequest =  # UpdateBusinessPricesRequest | 

try:
    # Установка цен на товары во всех магазинах
    api_response = api_instance.update_business_prices(businessId, updateBusinessPricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PricesApi->updateBusinessPrices: %s\n" % e)
extern crate PricesApi;

pub fn main() {
    let businessId = 789; // Long
    let updateBusinessPricesRequest = ; // UpdateBusinessPricesRequest

    let mut context = PricesApi::Context::default();
    let result = client.updateBusinessPrices(businessId, updateBusinessPricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateBusinessPricesRequest *

Responses


updatePrices

Установка цен на товары в конкретном магазине

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос [POST businesses/{businessId}/offers/recommendations](../../reference/business-assortment/getOfferRecommendations.md). {% note warning "Метод только для отдельных магазинов" %} Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах. Для управления базовыми ценами используйте [POST businesses/{businessId}/offer-prices/updates](../../reference/business-assortment/updateBusinessPrices.md). {% endnote %} {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 5000 товаров в минуту| |-|


/campaigns/{campaignId}/offer-prices/updates

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/updates" \
 -d '{
  "offers" : [ {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  }, {
    "price" : {
      "vat" : 1,
      "discountBase" : 6.027456183070403,
      "currencyId" : "RUR",
      "value" : 0.8008281904610115
    },
    "offerId" : "offerId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PricesApi;

import java.io.File;
import java.util.*;

public class PricesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#updatePrices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePricesRequest updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

try {
    final result = await api_instance.updatePrices(campaignId, updatePricesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePrices: $e\n');
}

import org.openapitools.client.api.PricesApi;

public class PricesApiExample {
    public static void main(String[] args) {
        PricesApi apiInstance = new PricesApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePricesRequest updatePricesRequest = ; // UpdatePricesRequest | 

        try {
            EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PricesApi#updatePrices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PricesApi *apiInstance = [[PricesApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePricesRequest *updatePricesRequest = ; // 

// Установка цен на товары в конкретном магазине
[apiInstance updatePricesWith:campaignId
    updatePricesRequest:updatePricesRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PricesApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePricesRequest = ; // {UpdatePricesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePrices(campaignId, updatePricesRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePricesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PricesApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePricesRequest = new UpdatePricesRequest(); // UpdatePricesRequest | 

            try {
                // Установка цен на товары в конкретном магазине
                EmptyApiResponse result = apiInstance.updatePrices(campaignId, updatePricesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PricesApi.updatePrices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PricesApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePricesRequest = ; // UpdatePricesRequest | 

try {
    $result = $api_instance->updatePrices($campaignId, $updatePricesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricesApi->updatePrices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PricesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PricesApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePricesRequest = WWW::OPenAPIClient::Object::UpdatePricesRequest->new(); # UpdatePricesRequest | 

eval {
    my $result = $api_instance->updatePrices(campaignId => $campaignId, updatePricesRequest => $updatePricesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PricesApi->updatePrices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PricesApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePricesRequest =  # UpdatePricesRequest | 

try:
    # Установка цен на товары в конкретном магазине
    api_response = api_instance.update_prices(campaignId, updatePricesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PricesApi->updatePrices: %s\n" % e)
extern crate PricesApi;

pub fn main() {
    let campaignId = 789; // Long
    let updatePricesRequest = ; // UpdatePricesRequest

    let mut context = PricesApi::Context::default();
    let result = client.updatePrices(campaignId, updatePricesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePricesRequest *

Responses


Promos

deletePromoOffers

Удаление товаров из акции

Убирает товары из акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/delete

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete" \
 -d '{
  "deleteAllOffers" : true,
  "promoId" : "promoId",
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PromosApi;

import java.io.File;
import java.util.*;

public class PromosApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final DeletePromoOffersRequest deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

try {
    final result = await api_instance.deletePromoOffers(businessId, deletePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePromoOffers: $e\n');
}

import org.openapitools.client.api.PromosApi;

public class PromosApiExample {
    public static void main(String[] args) {
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        DeletePromoOffersRequest deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

        try {
            DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#deletePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PromosApi *apiInstance = [[PromosApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
DeletePromoOffersRequest *deletePromoOffersRequest = ; // 

// Удаление товаров из акции
[apiInstance deletePromoOffersWith:businessId
    deletePromoOffersRequest:deletePromoOffersRequest
              completionHandler: ^(DeletePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PromosApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var deletePromoOffersRequest = ; // {DeletePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePromoOffers(businessId, deletePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class deletePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PromosApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var deletePromoOffersRequest = new DeletePromoOffersRequest(); // DeletePromoOffersRequest | 

            try {
                // Удаление товаров из акции
                DeletePromoOffersResponse result = apiInstance.deletePromoOffers(businessId, deletePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PromosApi.deletePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PromosApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$deletePromoOffersRequest = ; // DeletePromoOffersRequest | 

try {
    $result = $api_instance->deletePromoOffers($businessId, $deletePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PromosApi->deletePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PromosApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PromosApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $deletePromoOffersRequest = WWW::OPenAPIClient::Object::DeletePromoOffersRequest->new(); # DeletePromoOffersRequest | 

eval {
    my $result = $api_instance->deletePromoOffers(businessId => $businessId, deletePromoOffersRequest => $deletePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PromosApi->deletePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PromosApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
deletePromoOffersRequest =  # DeletePromoOffersRequest | 

try:
    # Удаление товаров из акции
    api_response = api_instance.delete_promo_offers(businessId, deletePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PromosApi->deletePromoOffers: %s\n" % e)
extern crate PromosApi;

pub fn main() {
    let businessId = 789; // Long
    let deletePromoOffersRequest = ; // DeletePromoOffersRequest

    let mut context = PromosApi::Context::default();
    let result = client.deletePromoOffers(businessId, deletePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
deletePromoOffersRequest *

Responses


getPromoOffers

Получение списка товаров, которые участвуют или могут участвовать в акции

Возвращает список товаров, которые участвуют или могут участвовать в акции. {% note warning %} В параметре `limit` не передавайте значение больше 500. {% endnote %} |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "statusType" : "MANUALLY_ADDED",
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PromosApi;

import java.io.File;
import java.util.*;

public class PromosApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromoOffersRequest getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromoOffers: $e\n');
}

import org.openapitools.client.api.PromosApi;

public class PromosApiExample {
    public static void main(String[] args) {
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromoOffersRequest getPromoOffersRequest = ; // GetPromoOffersRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#getPromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PromosApi *apiInstance = [[PromosApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromoOffersRequest *getPromoOffersRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение списка товаров, которые участвуют или могут участвовать в акции
[apiInstance getPromoOffersWith:businessId
    getPromoOffersRequest:getPromoOffersRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetPromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PromosApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getPromoOffersRequest = ; // {GetPromoOffersRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromoOffers(businessId, getPromoOffersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PromosApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromoOffersRequest = new GetPromoOffersRequest(); // GetPromoOffersRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение списка товаров, которые участвуют или могут участвовать в акции
                GetPromoOffersResponse result = apiInstance.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PromosApi.getPromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PromosApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromoOffersRequest = ; // GetPromoOffersRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->getPromoOffers($businessId, $getPromoOffersRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PromosApi->getPromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PromosApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PromosApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromoOffersRequest = WWW::OPenAPIClient::Object::GetPromoOffersRequest->new(); # GetPromoOffersRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->getPromoOffers(businessId => $businessId, getPromoOffersRequest => $getPromoOffersRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PromosApi->getPromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PromosApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromoOffersRequest =  # GetPromoOffersRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение списка товаров, которые участвуют или могут участвовать в акции
    api_response = api_instance.get_promo_offers(businessId, getPromoOffersRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PromosApi->getPromoOffers: %s\n" % e)
extern crate PromosApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromoOffersRequest = ; // GetPromoOffersRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = PromosApi::Context::default();
    let result = client.getPromoOffers(businessId, getPromoOffersRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromoOffersRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


getPromos

Получение списка акций

Возвращает информацию об акциях Маркета. По умолчанию возвращаются акции, в которых продавец участвует или может принять участие. Чтобы получить текущие или завершенные акции, передайте параметр `participation`. Типы акций, которые возвращаются в ответе: * прямая скидка; * флеш-акция; * скидка по промокоду. |**⚙️ Лимит:** 1000 запросов в час| |-|


/businesses/{businessId}/promos

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos" \
 -d '{
  "participation" : "PARTICIPATING_NOW",
  "mechanics" : "DIRECT_DISCOUNT"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PromosApi;

import java.io.File;
import java.util.*;

public class PromosApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#getPromos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetPromosRequest getPromosRequest = new GetPromosRequest(); // GetPromosRequest | 

try {
    final result = await api_instance.getPromos(businessId, getPromosRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPromos: $e\n');
}

import org.openapitools.client.api.PromosApi;

public class PromosApiExample {
    public static void main(String[] args) {
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetPromosRequest getPromosRequest = ; // GetPromosRequest | 

        try {
            GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#getPromos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PromosApi *apiInstance = [[PromosApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetPromosRequest *getPromosRequest = ; //  (optional)

// Получение списка акций
[apiInstance getPromosWith:businessId
    getPromosRequest:getPromosRequest
              completionHandler: ^(GetPromosResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PromosApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'getPromosRequest':  // {GetPromosRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromos(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getPromosExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PromosApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getPromosRequest = new GetPromosRequest(); // GetPromosRequest |  (optional) 

            try {
                // Получение списка акций
                GetPromosResponse result = apiInstance.getPromos(businessId, getPromosRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PromosApi.getPromos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PromosApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getPromosRequest = ; // GetPromosRequest | 

try {
    $result = $api_instance->getPromos($businessId, $getPromosRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PromosApi->getPromos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PromosApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PromosApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getPromosRequest = WWW::OPenAPIClient::Object::GetPromosRequest->new(); # GetPromosRequest | 

eval {
    my $result = $api_instance->getPromos(businessId => $businessId, getPromosRequest => $getPromosRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PromosApi->getPromos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PromosApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getPromosRequest =  # GetPromosRequest |  (optional)

try:
    # Получение списка акций
    api_response = api_instance.get_promos(businessId, getPromosRequest=getPromosRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PromosApi->getPromos: %s\n" % e)
extern crate PromosApi;

pub fn main() {
    let businessId = 789; // Long
    let getPromosRequest = ; // GetPromosRequest

    let mut context = PromosApi::Context::default();
    let result = client.getPromos(businessId, getPromosRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getPromosRequest

Responses


updatePromoOffers

Добавление товаров в акцию или изменение их цен

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции. Изменения начинают действовать в течение 4–6 часов. |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/promos/offers/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/update" \
 -d '{
  "offers" : [ {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  }, {
    "offerId" : "offerId",
    "params" : {
      "discountParams" : {
        "promoPrice" : 1,
        "price" : 1
      }
    }
  } ],
  "promoId" : "promoId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PromosApi;

import java.io.File;
import java.util.*;

public class PromosApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdatePromoOffersRequest updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

try {
    final result = await api_instance.updatePromoOffers(businessId, updatePromoOffersRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePromoOffers: $e\n');
}

import org.openapitools.client.api.PromosApi;

public class PromosApiExample {
    public static void main(String[] args) {
        PromosApi apiInstance = new PromosApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdatePromoOffersRequest updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

        try {
            UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromosApi#updatePromoOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
PromosApi *apiInstance = [[PromosApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdatePromoOffersRequest *updatePromoOffersRequest = ; // 

// Добавление товаров в акцию или изменение их цен
[apiInstance updatePromoOffersWith:businessId
    updatePromoOffersRequest:updatePromoOffersRequest
              completionHandler: ^(UpdatePromoOffersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.PromosApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updatePromoOffersRequest = ; // {UpdatePromoOffersRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePromoOffers(businessId, updatePromoOffersRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updatePromoOffersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PromosApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updatePromoOffersRequest = new UpdatePromoOffersRequest(); // UpdatePromoOffersRequest | 

            try {
                // Добавление товаров в акцию или изменение их цен
                UpdatePromoOffersResponse result = apiInstance.updatePromoOffers(businessId, updatePromoOffersRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PromosApi.updatePromoOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PromosApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updatePromoOffersRequest = ; // UpdatePromoOffersRequest | 

try {
    $result = $api_instance->updatePromoOffers($businessId, $updatePromoOffersRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PromosApi->updatePromoOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PromosApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PromosApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updatePromoOffersRequest = WWW::OPenAPIClient::Object::UpdatePromoOffersRequest->new(); # UpdatePromoOffersRequest | 

eval {
    my $result = $api_instance->updatePromoOffers(businessId => $businessId, updatePromoOffersRequest => $updatePromoOffersRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PromosApi->updatePromoOffers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PromosApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updatePromoOffersRequest =  # UpdatePromoOffersRequest | 

try:
    # Добавление товаров в акцию или изменение их цен
    api_response = api_instance.update_promo_offers(businessId, updatePromoOffersRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PromosApi->updatePromoOffers: %s\n" % e)
extern crate PromosApi;

pub fn main() {
    let businessId = 789; // Long
    let updatePromoOffersRequest = ; // UpdatePromoOffersRequest

    let mut context = PromosApi::Context::default();
    let result = client.updatePromoOffers(businessId, updatePromoOffersRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updatePromoOffersRequest *

Responses


Ratings

getQualityRatingDetails

Заказы, которые повлияли на индекс качества

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос [POST businesses/{businessId}/ratings/quality](../../reference/ratings/getQualityRatings.md). |**⚙️ Лимит:** 100000 запросов в час| |-|


/campaigns/{campaignId}/ratings/quality/details

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/ratings/quality/details"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RatingsApi;

import java.io.File;
import java.util.*;

public class RatingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        RatingsApi apiInstance = new RatingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getQualityRatingDetails(campaignId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatingDetails: $e\n');
}

import org.openapitools.client.api.RatingsApi;

public class RatingsApiExample {
    public static void main(String[] args) {
        RatingsApi apiInstance = new RatingsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingsApi#getQualityRatingDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
RatingsApi *apiInstance = [[RatingsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Заказы, которые повлияли на индекс качества
[apiInstance getQualityRatingDetailsWith:campaignId
              completionHandler: ^(GetQualityRatingDetailsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.RatingsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatingDetails(campaignId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RatingsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Заказы, которые повлияли на индекс качества
                GetQualityRatingDetailsResponse result = apiInstance.getQualityRatingDetails(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RatingsApi.getQualityRatingDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RatingsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getQualityRatingDetails($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RatingsApi->getQualityRatingDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RatingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RatingsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getQualityRatingDetails(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RatingsApi->getQualityRatingDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RatingsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Заказы, которые повлияли на индекс качества
    api_response = api_instance.get_quality_rating_details(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RatingsApi->getQualityRatingDetails: %s\n" % e)
extern crate RatingsApi;

pub fn main() {
    let campaignId = 789; // Long

    let mut context = RatingsApi::Context::default();
    let result = client.getQualityRatingDetails(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses


getQualityRatings

Индекс качества магазинов

Возвращает значение индекса качества магазинов и его составляющие. Подробнее об индексе качества читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/quality/score/). |**⚙️ Лимит:** 10000 запросов в час| |-|


/businesses/{businessId}/ratings/quality

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality" \
 -d '{
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 0, 0, 0, 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RatingsApi;

import java.io.File;
import java.util.*;

public class RatingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        RatingsApi apiInstance = new RatingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final GetQualityRatingRequest getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

try {
    final result = await api_instance.getQualityRatings(businessId, getQualityRatingRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getQualityRatings: $e\n');
}

import org.openapitools.client.api.RatingsApi;

public class RatingsApiExample {
    public static void main(String[] args) {
        RatingsApi apiInstance = new RatingsApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        GetQualityRatingRequest getQualityRatingRequest = ; // GetQualityRatingRequest | 

        try {
            GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingsApi#getQualityRatings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
RatingsApi *apiInstance = [[RatingsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
GetQualityRatingRequest *getQualityRatingRequest = ; // 

// Индекс качества магазинов
[apiInstance getQualityRatingsWith:businessId
    getQualityRatingRequest:getQualityRatingRequest
              completionHandler: ^(GetQualityRatingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.RatingsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var getQualityRatingRequest = ; // {GetQualityRatingRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityRatings(businessId, getQualityRatingRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getQualityRatingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RatingsApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var getQualityRatingRequest = new GetQualityRatingRequest(); // GetQualityRatingRequest | 

            try {
                // Индекс качества магазинов
                GetQualityRatingResponse result = apiInstance.getQualityRatings(businessId, getQualityRatingRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RatingsApi.getQualityRatings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RatingsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$getQualityRatingRequest = ; // GetQualityRatingRequest | 

try {
    $result = $api_instance->getQualityRatings($businessId, $getQualityRatingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RatingsApi->getQualityRatings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RatingsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RatingsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $getQualityRatingRequest = WWW::OPenAPIClient::Object::GetQualityRatingRequest->new(); # GetQualityRatingRequest | 

eval {
    my $result = $api_instance->getQualityRatings(businessId => $businessId, getQualityRatingRequest => $getQualityRatingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RatingsApi->getQualityRatings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RatingsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
getQualityRatingRequest =  # GetQualityRatingRequest | 

try:
    # Индекс качества магазинов
    api_response = api_instance.get_quality_ratings(businessId, getQualityRatingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RatingsApi->getQualityRatings: %s\n" % e)
extern crate RatingsApi;

pub fn main() {
    let businessId = 789; // Long
    let getQualityRatingRequest = ; // GetQualityRatingRequest

    let mut context = RatingsApi::Context::default();
    let result = client.getQualityRatings(businessId, getQualityRatingRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getQualityRatingRequest *

Responses


Regions

searchRegionChildren

Информация о дочерних регионах

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}/children

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}/children?page=56&pageSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

final Integer page = new Integer(); // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

final Integer pageSize = new Integer(); // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    final result = await api_instance.searchRegionChildren(regionId, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionChildren: $e\n');
}

import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

        Integer page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

        Integer pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


        try {
            GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionChildren");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
Integer *page = 56; // Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
Integer *pageSize = 56; // Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

// Информация о дочерних регионах
[apiInstance searchRegionChildrenWith:regionId
    page:page
    pageSize:pageSize
              completionHandler: ^(GetRegionWithChildrenResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.RegionsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

var opts = {
  'page': 56, // {Integer} Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

  'pageSize': 56 // {Integer} Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionChildren(regionId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionChildrenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
            var page = 56;  // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to 1)
            var pageSize = 56;  // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional)  (default to null)

            try {
                // Информация о дочерних регионах
                GetRegionWithChildrenResponse result = apiInstance.searchRegionChildren(regionId, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.searchRegionChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

$page = 56; // Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

$pageSize = 56; // Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


try {
    $result = $api_instance->searchRegionChildren($regionId, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->searchRegionChildren: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).

my $page = 56; # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

my $pageSize = 56; # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.


eval {
    my $result = $api_instance->searchRegionChildren(regionId => $regionId, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->searchRegionChildren: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)
page = 56 # Integer | Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром `page_size`.

`page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to 1)
pageSize = 56 # Integer | Размер страницы.

Используется вместе с параметром `page_number`.

`page_size` игнорируется, если задан `page_token`, `limit` или `offset`.
 (optional) (default to null)

try:
    # Информация о дочерних регионах
    api_response = api_instance.search_region_children(regionId, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->searchRegionChildren: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let regionId = 789; // Long
    let page = 56; // Integer
    let pageSize = 56; // Integer

    let mut context = RegionsApi::Context::default();
    let result = client.searchRegionChildren(regionId, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required
Query parameters
Name Description
page
Integer (int32)
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize
Integer (int32)
Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

Responses


searchRegionsById

Информация о регионе

Возвращает информацию о регионе. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions/{regionId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long regionId = new Long(); // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    final result = await api_instance.searchRegionsById(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsById: $e\n');
}

import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        Long regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


        try {
            GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
Long *regionId = 789; // Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

// Информация о регионе
[apiInstance searchRegionsByIdWith:regionId
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.RegionsApi()
var regionId = 789; // {Long} Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsById(regionId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var regionId = 789;  // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

            try {
                // Информация о регионе
                GetRegionsResponse result = apiInstance.searchRegionsById(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.searchRegionsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$regionId = 789; // Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


try {
    $result = $api_instance->searchRegionsById($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->searchRegionsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $regionId = 789; # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).


eval {
    my $result = $api_instance->searchRegionsById(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->searchRegionsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
regionId = 789 # Long | Идентификатор региона.

Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
 (default to null)

try:
    # Информация о регионе
    api_response = api_instance.search_regions_by_id(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->searchRegionsById: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let regionId = 789; // Long

    let mut context = RegionsApi::Context::default();
    let result = client.searchRegionsById(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
regionId*
Long (int64)
Идентификатор региона. Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
Required

Responses


searchRegionsByName

Поиск регионов по их имени

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска. Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам. Для методов `GET regions`, `GET regions/{regionId}` и `GET regions/{regionId}/children` действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов). Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов. |**⚙️ Лимит:** 50 000 запросов в час| |-|


/regions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/regions?name=name_example&page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchRegionsByName(name, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRegionsByName: $e\n');
}

import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        String name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#searchRegionsByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
String *name = name_example; // Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Поиск регионов по их имени
[apiInstance searchRegionsByNameWith:name
    pageToken:pageToken
    limit:limit
              completionHandler: ^(GetRegionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.RegionsApi()
var name = name_example; // {String} Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegionsByName(name, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchRegionsByNameExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var name = name_example;  // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Поиск регионов по их имени
                GetRegionsResponse result = apiInstance.searchRegionsByName(name, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.searchRegionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$name = name_example; // String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchRegionsByName($name, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->searchRegionsByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $name = name_example; # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchRegionsByName(name => $name, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->searchRegionsByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
name = name_example # String | Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Поиск регионов по их имени
    api_response = api_instance.search_regions_by_name(name, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->searchRegionsByName: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let name = name_example; // String
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = RegionsApi::Context::default();
    let result = client.searchRegionsByName(name, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Query parameters
Name Description
name*
String
Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, `Москва`.
Required
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


Reports

generateBoostConsolidatedReport

Отчет по бусту продаж

Запускает генерацию **сводного отчета по бусту продаж** за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/boost-consolidated/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/boost-consolidated/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBoostConsolidatedReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateBoostConsolidatedRequest generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateBoostConsolidatedReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateBoostConsolidatedRequest *generateBoostConsolidatedRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по бусту продаж
[apiInstance generateBoostConsolidatedReportWith:generateBoostConsolidatedRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateBoostConsolidatedRequest = ; // {GenerateBoostConsolidatedRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateBoostConsolidatedReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateBoostConsolidatedRequest = new GenerateBoostConsolidatedRequest(); // GenerateBoostConsolidatedRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по бусту продаж
                GenerateReportResponse result = apiInstance.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateBoostConsolidatedReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateBoostConsolidatedReport($generateBoostConsolidatedRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateBoostConsolidatedReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateBoostConsolidatedRequest = WWW::OPenAPIClient::Object::GenerateBoostConsolidatedRequest->new(); # GenerateBoostConsolidatedRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateBoostConsolidatedReport(generateBoostConsolidatedRequest => $generateBoostConsolidatedRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateBoostConsolidatedReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateBoostConsolidatedRequest =  # GenerateBoostConsolidatedRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по бусту продаж
    api_response = api_instance.generate_boost_consolidated_report(generateBoostConsolidatedRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateBoostConsolidatedReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateBoostConsolidatedRequest = ; // GenerateBoostConsolidatedRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateBoostConsolidatedReport(generateBoostConsolidatedRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateBoostConsolidatedRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateCompetitorsPositionReport

Отчет «Конкурентная позиция»

Запускает генерацию **отчета «Конкурентная позиция»** за заданный период. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/analytics/competitors.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). {% note info "Значение -1 в отчете" %} Если в CSV-файле в столбце **POSITION** стоит -1, в этот день не было заказов с товарами в указанной категории. {% endnote %} |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/competitors-position/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/competitors-position/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "categoryId" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateCompetitorsPositionReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateCompetitorsPositionReportRequest generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateCompetitorsPositionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateCompetitorsPositionReportRequest *generateCompetitorsPositionReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Конкурентная позиция»
[apiInstance generateCompetitorsPositionReportWith:generateCompetitorsPositionReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateCompetitorsPositionReportRequest = ; // {GenerateCompetitorsPositionReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateCompetitorsPositionReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateCompetitorsPositionReportRequest = new GenerateCompetitorsPositionReportRequest(); // GenerateCompetitorsPositionReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Конкурентная позиция»
                GenerateReportResponse result = apiInstance.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateCompetitorsPositionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateCompetitorsPositionReport($generateCompetitorsPositionReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateCompetitorsPositionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateCompetitorsPositionReportRequest = WWW::OPenAPIClient::Object::GenerateCompetitorsPositionReportRequest->new(); # GenerateCompetitorsPositionReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest => $generateCompetitorsPositionReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateCompetitorsPositionReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateCompetitorsPositionReportRequest =  # GenerateCompetitorsPositionReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Конкурентная позиция»
    api_response = api_instance.generate_competitors_position_report(generateCompetitorsPositionReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateCompetitorsPositionReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateCompetitorsPositionReportRequest = ; // GenerateCompetitorsPositionReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateCompetitorsPositionReport(generateCompetitorsPositionReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateCompetitorsPositionReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsFeedbackReport

Отчет по отзывам о товарах

Запускает генерацию **отчета по отзывам о товарах**. [Что это за отчет](https://yandex.ru/support2/marketplace/ru/marketing/plus-reviews#stat) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-feedback/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-feedback/generate?format=" \
 -d '{
  "businessId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsFeedbackReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsFeedbackRequest generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateGoodsFeedbackRequest *generateGoodsFeedbackRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по отзывам о товарах
[apiInstance generateGoodsFeedbackReportWith:generateGoodsFeedbackRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateGoodsFeedbackRequest = ; // {GenerateGoodsFeedbackRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsFeedbackReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateGoodsFeedbackRequest = new GenerateGoodsFeedbackRequest(); // GenerateGoodsFeedbackRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по отзывам о товарах
                GenerateReportResponse result = apiInstance.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateGoodsFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsFeedbackReport($generateGoodsFeedbackRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateGoodsFeedbackRequest = WWW::OPenAPIClient::Object::GenerateGoodsFeedbackRequest->new(); # GenerateGoodsFeedbackRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsFeedbackReport(generateGoodsFeedbackRequest => $generateGoodsFeedbackRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateGoodsFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateGoodsFeedbackRequest =  # GenerateGoodsFeedbackRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по отзывам о товарах
    api_response = api_instance.generate_goods_feedback_report(generateGoodsFeedbackRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateGoodsFeedbackReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateGoodsFeedbackRequest = ; // GenerateGoodsFeedbackRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateGoodsFeedbackReport(generateGoodsFeedbackRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsFeedbackRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsMovementReport

Отчет по движению товаров

Запускает генерацию **отчета по движению товаров**. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#flow) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-movement/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-movement/generate?format=" \
 -d '{
  "shopSku" : "shopSku",
  "campaignId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsMovementReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = new GenerateGoodsMovementReportRequest(); // GenerateGoodsMovementReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsMovementReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsMovementReportRequest generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsMovementReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateGoodsMovementReportRequest *generateGoodsMovementReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по движению товаров
[apiInstance generateGoodsMovementReportWith:generateGoodsMovementReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateGoodsMovementReportRequest = ; // {GenerateGoodsMovementReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsMovementReport(generateGoodsMovementReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsMovementReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateGoodsMovementReportRequest = new GenerateGoodsMovementReportRequest(); // GenerateGoodsMovementReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по движению товаров
                GenerateReportResponse result = apiInstance.generateGoodsMovementReport(generateGoodsMovementReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateGoodsMovementReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsMovementReport($generateGoodsMovementReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsMovementReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateGoodsMovementReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsMovementReportRequest->new(); # GenerateGoodsMovementReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsMovementReport(generateGoodsMovementReportRequest => $generateGoodsMovementReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateGoodsMovementReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateGoodsMovementReportRequest =  # GenerateGoodsMovementReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по движению товаров
    api_response = api_instance.generate_goods_movement_report(generateGoodsMovementReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateGoodsMovementReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateGoodsMovementReportRequest = ; // GenerateGoodsMovementReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateGoodsMovementReport(generateGoodsMovementReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsMovementReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsRealizationReport

Отчет по реализации

Запускает генерацию **отчета по реализации** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports-fby-fbs.html#sales-report) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-realization/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-realization/generate?format=" \
 -d '{
  "month" : 2,
  "year" : 6,
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsRealizationReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsRealizationReportRequest generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsRealizationReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateGoodsRealizationReportRequest *generateGoodsRealizationReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по реализации
[apiInstance generateGoodsRealizationReportWith:generateGoodsRealizationReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateGoodsRealizationReportRequest = ; // {GenerateGoodsRealizationReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsRealizationReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateGoodsRealizationReportRequest = new GenerateGoodsRealizationReportRequest(); // GenerateGoodsRealizationReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по реализации
                GenerateReportResponse result = apiInstance.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateGoodsRealizationReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsRealizationReport($generateGoodsRealizationReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsRealizationReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateGoodsRealizationReportRequest = WWW::OPenAPIClient::Object::GenerateGoodsRealizationReportRequest->new(); # GenerateGoodsRealizationReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsRealizationReport(generateGoodsRealizationReportRequest => $generateGoodsRealizationReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateGoodsRealizationReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateGoodsRealizationReportRequest =  # GenerateGoodsRealizationReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по реализации
    api_response = api_instance.generate_goods_realization_report(generateGoodsRealizationReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateGoodsRealizationReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateGoodsRealizationReportRequest = ; // GenerateGoodsRealizationReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateGoodsRealizationReport(generateGoodsRealizationReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsRealizationReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateGoodsTurnoverReport

Отчет по оборачиваемости

Запускает генерацию **отчета по оборачиваемости** за заданную дату. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/turnover.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/goods-turnover/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/goods-turnover/generate?format=" \
 -d '{
  "date" : "2000-01-23",
  "campaignId" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsTurnoverReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = new GenerateGoodsTurnoverRequest(); // GenerateGoodsTurnoverRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateGoodsTurnoverReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateGoodsTurnoverRequest generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateGoodsTurnoverReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateGoodsTurnoverRequest *generateGoodsTurnoverRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по оборачиваемости
[apiInstance generateGoodsTurnoverReportWith:generateGoodsTurnoverRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateGoodsTurnoverRequest = ; // {GenerateGoodsTurnoverRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateGoodsTurnoverReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateGoodsTurnoverRequest = new GenerateGoodsTurnoverRequest(); // GenerateGoodsTurnoverRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по оборачиваемости
                GenerateReportResponse result = apiInstance.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateGoodsTurnoverReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateGoodsTurnoverReport($generateGoodsTurnoverRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsTurnoverReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateGoodsTurnoverRequest = WWW::OPenAPIClient::Object::GenerateGoodsTurnoverRequest->new(); # GenerateGoodsTurnoverRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateGoodsTurnoverReport(generateGoodsTurnoverRequest => $generateGoodsTurnoverRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateGoodsTurnoverReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateGoodsTurnoverRequest =  # GenerateGoodsTurnoverRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по оборачиваемости
    api_response = api_instance.generate_goods_turnover_report(generateGoodsTurnoverRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateGoodsTurnoverReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateGoodsTurnoverRequest = ; // GenerateGoodsTurnoverRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateGoodsTurnoverReport(generateGoodsTurnoverRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateGoodsTurnoverRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateMassOrderLabelsReport

Готовые ярлыки‑наклейки на все коробки в нескольких заказах

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано [в Справке Маркета для продавцов](https://yandex.ru/support/marketplace/orders/fbs/packaging/marking.html). Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 1000 запросов в час| |-|


/reports/documents/labels/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/labels/generate?format=" \
 -d '{
  "businessId" : 0,
  "orderIds" : [ 6, 6, 6, 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
final PageFormatType format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    final result = await api_instance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateMassOrderLabelsReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateMassOrderLabelsRequest generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
        PageFormatType format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

        try {
            GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateMassOrderLabelsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateMassOrderLabelsRequest *generateMassOrderLabelsRequest = ; // 
PageFormatType *format = ; // Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

// Готовые ярлыки‑наклейки на все коробки в нескольких заказах
[apiInstance generateMassOrderLabelsReportWith:generateMassOrderLabelsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateMassOrderLabelsRequest = ; // {GenerateMassOrderLabelsRequest} 
var opts = {
  'format':  // {PageFormatType} Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateMassOrderLabelsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateMassOrderLabelsRequest = new GenerateMassOrderLabelsRequest(); // GenerateMassOrderLabelsRequest | 
            var format = new PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional)  (default to null)

            try {
                // Готовые ярлыки‑наклейки на все коробки в нескольких заказах
                GenerateReportResponse result = apiInstance.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateMassOrderLabelsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest | 
$format = ; // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

try {
    $result = $api_instance->generateMassOrderLabelsReport($generateMassOrderLabelsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateMassOrderLabelsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateMassOrderLabelsRequest = WWW::OPenAPIClient::Object::GenerateMassOrderLabelsRequest->new(); # GenerateMassOrderLabelsRequest | 
my $format = ; # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

eval {
    my $result = $api_instance->generateMassOrderLabelsReport(generateMassOrderLabelsRequest => $generateMassOrderLabelsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateMassOrderLabelsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateMassOrderLabelsRequest =  # GenerateMassOrderLabelsRequest | 
format =  # PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. (optional) (default to null)

try:
    # Готовые ярлыки‑наклейки на все коробки в нескольких заказах
    api_response = api_instance.generate_mass_order_labels_report(generateMassOrderLabelsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateMassOrderLabelsReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateMassOrderLabelsRequest = ; // GenerateMassOrderLabelsRequest
    let format = ; // PageFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateMassOrderLabelsReport(generateMassOrderLabelsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateMassOrderLabelsRequest *

Query parameters
Name Description
format
PageFormatType
Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Responses


generatePricesReport

Отчет «Цены на рынке»

Запускает генерацию **отчета «Цены на рынке»**. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/prices/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/prices/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "creationDateTo" : "2000-01-23",
  "campaignId" : 6,
  "businessId" : 0,
  "creationDateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GeneratePricesReportRequest generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generatePricesReport(generatePricesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generatePricesReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GeneratePricesReportRequest generatePricesReportRequest = ; // GeneratePricesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generatePricesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GeneratePricesReportRequest *generatePricesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Цены на рынке»
[apiInstance generatePricesReportWith:generatePricesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generatePricesReportRequest = ; // {GeneratePricesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generatePricesReport(generatePricesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generatePricesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generatePricesReportRequest = new GeneratePricesReportRequest(); // GeneratePricesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Цены на рынке»
                GenerateReportResponse result = apiInstance.generatePricesReport(generatePricesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generatePricesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generatePricesReportRequest = ; // GeneratePricesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generatePricesReport($generatePricesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generatePricesReportRequest = WWW::OPenAPIClient::Object::GeneratePricesReportRequest->new(); # GeneratePricesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generatePricesReport(generatePricesReportRequest => $generatePricesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generatePricesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generatePricesReportRequest =  # GeneratePricesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Цены на рынке»
    api_response = api_instance.generate_prices_report(generatePricesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generatePricesReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generatePricesReportRequest = ; // GeneratePricesReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generatePricesReport(generatePricesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generatePricesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShelfsStatisticsReport

Отчет по полкам

Запускает генерацию **сводного отчета по полкам** — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf). Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/shelf-statistics/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shelf-statistics/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "attributionType" : "CLICKS"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShelfsStatisticsReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateShelfsStatisticsRequest generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShelfsStatisticsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateShelfsStatisticsRequest *generateShelfsStatisticsRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по полкам
[apiInstance generateShelfsStatisticsReportWith:generateShelfsStatisticsRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateShelfsStatisticsRequest = ; // {GenerateShelfsStatisticsRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShelfsStatisticsReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateShelfsStatisticsRequest = new GenerateShelfsStatisticsRequest(); // GenerateShelfsStatisticsRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по полкам
                GenerateReportResponse result = apiInstance.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateShelfsStatisticsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShelfsStatisticsReport($generateShelfsStatisticsRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateShelfsStatisticsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateShelfsStatisticsRequest = WWW::OPenAPIClient::Object::GenerateShelfsStatisticsRequest->new(); # GenerateShelfsStatisticsRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShelfsStatisticsReport(generateShelfsStatisticsRequest => $generateShelfsStatisticsRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateShelfsStatisticsReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateShelfsStatisticsRequest =  # GenerateShelfsStatisticsRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по полкам
    api_response = api_instance.generate_shelfs_statistics_report(generateShelfsStatisticsRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateShelfsStatisticsReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateShelfsStatisticsRequest = ; // GenerateShelfsStatisticsRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateShelfsStatisticsReport(generateShelfsStatisticsRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShelfsStatisticsRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateShipmentListDocumentReport

Получение листа сборки

Запускает генерацию **листа сборки** для отгрузки. Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/documents/shipment-list/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/documents/shipment-list/generate" \
 -d '{
  "campaignId" : 0,
  "shipmentId" : 6,
  "orderIds" : [ 1, 1 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

        try {
            GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShipmentListDocumentReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = new GenerateShipmentListDocumentReportRequest(); // GenerateShipmentListDocumentReportRequest | 

try {
    final result = await api_instance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShipmentListDocumentReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateShipmentListDocumentReportRequest generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

        try {
            GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShipmentListDocumentReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateShipmentListDocumentReportRequest *generateShipmentListDocumentReportRequest = ; // 

// Получение листа сборки
[apiInstance generateShipmentListDocumentReportWith:generateShipmentListDocumentReportRequest
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateShipmentListDocumentReportRequest = ; // {GenerateShipmentListDocumentReportRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShipmentListDocumentReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateShipmentListDocumentReportRequest = new GenerateShipmentListDocumentReportRequest(); // GenerateShipmentListDocumentReportRequest | 

            try {
                // Получение листа сборки
                GenerateReportResponse result = apiInstance.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateShipmentListDocumentReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest | 

try {
    $result = $api_instance->generateShipmentListDocumentReport($generateShipmentListDocumentReportRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateShipmentListDocumentReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateShipmentListDocumentReportRequest = WWW::OPenAPIClient::Object::GenerateShipmentListDocumentReportRequest->new(); # GenerateShipmentListDocumentReportRequest | 

eval {
    my $result = $api_instance->generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest => $generateShipmentListDocumentReportRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateShipmentListDocumentReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateShipmentListDocumentReportRequest =  # GenerateShipmentListDocumentReportRequest | 

try:
    # Получение листа сборки
    api_response = api_instance.generate_shipment_list_document_report(generateShipmentListDocumentReportRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateShipmentListDocumentReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateShipmentListDocumentReportRequest = ; // GenerateShipmentListDocumentReportRequest

    let mut context = ReportsApi::Context::default();
    let result = client.generateShipmentListDocumentReport(generateShipmentListDocumentReportRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShipmentListDocumentReportRequest *

Responses


generateShowsSalesReport

Отчет «Аналитика продаж»

Запускает генерацию **отчета «Аналитика продаж»** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/shows-sales.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 10 запросов в час| |-|


/reports/shows-sales/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=" \
 -d '{
  "campaignId" : 6,
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateFrom" : "2000-01-23",
  "grouping" : "CATEGORIES"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateShowsSalesReportRequest generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateShowsSalesReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateShowsSalesReportRequest generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateShowsSalesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateShowsSalesReportRequest *generateShowsSalesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет «Аналитика продаж»
[apiInstance generateShowsSalesReportWith:generateShowsSalesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateShowsSalesReportRequest = ; // {GenerateShowsSalesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateShowsSalesReport(generateShowsSalesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateShowsSalesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateShowsSalesReportRequest = new GenerateShowsSalesReportRequest(); // GenerateShowsSalesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет «Аналитика продаж»
                GenerateReportResponse result = apiInstance.generateShowsSalesReport(generateShowsSalesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateShowsSalesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateShowsSalesReport($generateShowsSalesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateShowsSalesReportRequest = WWW::OPenAPIClient::Object::GenerateShowsSalesReportRequest->new(); # GenerateShowsSalesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateShowsSalesReport(generateShowsSalesReportRequest => $generateShowsSalesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateShowsSalesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateShowsSalesReportRequest =  # GenerateShowsSalesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет «Аналитика продаж»
    api_response = api_instance.generate_shows_sales_report(generateShowsSalesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateShowsSalesReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateShowsSalesReportRequest = ; // GenerateShowsSalesReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateShowsSalesReport(generateShowsSalesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateShowsSalesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateStocksOnWarehousesReport

Отчет по остаткам на складах

Запускает генерацию **отчета по остаткам на складах**. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. * Для остальных моделей — об остатках на соответствующем складе магазина. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/stocks-on-warehouses/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate?format=" \
 -d '{
  "categoryIds" : [ 1, 1 ],
  "hasStocks" : true,
  "reportDate" : "2000-01-23",
  "campaignId" : 0,
  "warehouseIds" : [ 6, 6 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateStocksOnWarehousesReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateStocksOnWarehousesReportRequest generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateStocksOnWarehousesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateStocksOnWarehousesReportRequest *generateStocksOnWarehousesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по остаткам на складах
[apiInstance generateStocksOnWarehousesReportWith:generateStocksOnWarehousesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateStocksOnWarehousesReportRequest = ; // {GenerateStocksOnWarehousesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateStocksOnWarehousesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateStocksOnWarehousesReportRequest = new GenerateStocksOnWarehousesReportRequest(); // GenerateStocksOnWarehousesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по остаткам на складах
                GenerateReportResponse result = apiInstance.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateStocksOnWarehousesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateStocksOnWarehousesReport($generateStocksOnWarehousesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateStocksOnWarehousesReportRequest = WWW::OPenAPIClient::Object::GenerateStocksOnWarehousesReportRequest->new(); # GenerateStocksOnWarehousesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest => $generateStocksOnWarehousesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateStocksOnWarehousesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateStocksOnWarehousesReportRequest =  # GenerateStocksOnWarehousesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по остаткам на складах
    api_response = api_instance.generate_stocks_on_warehouses_report(generateStocksOnWarehousesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateStocksOnWarehousesReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateStocksOnWarehousesReportRequest = ; // GenerateStocksOnWarehousesReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateStocksOnWarehousesReport(generateStocksOnWarehousesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateStocksOnWarehousesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedMarketplaceServicesReport

Отчет по стоимости услуг

Запускает генерацию **отчета по стоимости услуг** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/reports.html) Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-----------------------------|---------------------------------| |По дате начисления услуги |`dateFrom` и `dateTo` | |По дате формирования акта |`year` и `month` | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-marketplace-services/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-marketplace-services/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "yearFrom" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "monthFrom" : 2,
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 2, 2 ],
  "dateFrom" : "2000-01-23",
  "monthTo" : 7,
  "yearTo" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedMarketplaceServicesReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedMarketplaceServicesReportRequest generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedMarketplaceServicesReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateUnitedMarketplaceServicesReportRequest *generateUnitedMarketplaceServicesReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по стоимости услуг
[apiInstance generateUnitedMarketplaceServicesReportWith:generateUnitedMarketplaceServicesReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateUnitedMarketplaceServicesReportRequest = ; // {GenerateUnitedMarketplaceServicesReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedMarketplaceServicesReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateUnitedMarketplaceServicesReportRequest = new GenerateUnitedMarketplaceServicesReportRequest(); // GenerateUnitedMarketplaceServicesReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по стоимости услуг
                GenerateReportResponse result = apiInstance.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateUnitedMarketplaceServicesReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedMarketplaceServicesReport($generateUnitedMarketplaceServicesReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateUnitedMarketplaceServicesReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedMarketplaceServicesReportRequest->new(); # GenerateUnitedMarketplaceServicesReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest => $generateUnitedMarketplaceServicesReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateUnitedMarketplaceServicesReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateUnitedMarketplaceServicesReportRequest =  # GenerateUnitedMarketplaceServicesReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по стоимости услуг
    api_response = api_instance.generate_united_marketplace_services_report(generateUnitedMarketplaceServicesReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateUnitedMarketplaceServicesReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateUnitedMarketplaceServicesReportRequest = ; // GenerateUnitedMarketplaceServicesReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateUnitedMarketplaceServicesReport(generateUnitedMarketplaceServicesReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedMarketplaceServicesReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedNettingReport

Отчет по платежам

Запускает генерацию **отчета по платежам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/transactions.html) Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). Тип отчета зависит от того, какие поля заполнены в запросе: |**Тип отчета** |**Какие поля нужны** | |-------------------------|---------------------------------------| |О платежах за период |`dateFrom` и `dateTo` | |О платежном поручении |`bankOrderId` и `bankOrderDateTime` | Заказать отчеты обоих типов одним запросом нельзя. |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-netting/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-netting/generate?format=" \
 -d '{
  "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
  "bankOrderId" : 6,
  "placementPrograms" : [ "FBS", "FBS" ],
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "dateTimeTo" : "2000-01-23T04:56:07.000+00:00",
  "inns" : [ "inns", "inns" ],
  "campaignIds" : [ 1, 1 ],
  "dateFrom" : "2000-01-23",
  "bankOrderDateTime" : "2000-01-23T04:56:07.000+00:00"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedNettingReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedNettingReportRequest generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedNettingReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateUnitedNettingReportRequest *generateUnitedNettingReportRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по платежам
[apiInstance generateUnitedNettingReportWith:generateUnitedNettingReportRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateUnitedNettingReportRequest = ; // {GenerateUnitedNettingReportRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedNettingReport(generateUnitedNettingReportRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedNettingReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateUnitedNettingReportRequest = new GenerateUnitedNettingReportRequest(); // GenerateUnitedNettingReportRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по платежам
                GenerateReportResponse result = apiInstance.generateUnitedNettingReport(generateUnitedNettingReportRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateUnitedNettingReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedNettingReport($generateUnitedNettingReportRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateUnitedNettingReportRequest = WWW::OPenAPIClient::Object::GenerateUnitedNettingReportRequest->new(); # GenerateUnitedNettingReportRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedNettingReport(generateUnitedNettingReportRequest => $generateUnitedNettingReportRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateUnitedNettingReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateUnitedNettingReportRequest =  # GenerateUnitedNettingReportRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по платежам
    api_response = api_instance.generate_united_netting_report(generateUnitedNettingReportRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateUnitedNettingReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateUnitedNettingReportRequest = ; // GenerateUnitedNettingReportRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateUnitedNettingReport(generateUnitedNettingReportRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedNettingReportRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


generateUnitedOrdersReport

Отчет по заказам

Запускает генерацию **отчета по заказам** за заданный период. [Что это за отчет](https://yandex.ru/support/marketplace/analytics/orders.html) {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. [Как получить детальную информацию по заказам](../../reference/stats/getOrdersStats.md) {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса [GET reports/info/{reportId}](../../reference/reports/getReportInfo.md). |**⚙️ Лимит:** 100 запросов в час| |-|


/reports/united-orders/generate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/reports/united-orders/generate?format=" \
 -d '{
  "businessId" : 0,
  "dateTo" : "2000-01-23",
  "campaignIds" : [ 6, 6 ],
  "promoId" : "promoId",
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateUnitedOrdersRequest generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
final ReportFormatType format = new ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    final result = await api_instance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateUnitedOrdersReport: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        GenerateUnitedOrdersRequest generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
        ReportFormatType format = ; // ReportFormatType | Формат отчета.

        try {
            GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#generateUnitedOrdersReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
GenerateUnitedOrdersRequest *generateUnitedOrdersRequest = ; // 
ReportFormatType *format = ; // Формат отчета. (optional) (default to null)

// Отчет по заказам
[apiInstance generateUnitedOrdersReportWith:generateUnitedOrdersRequest
    format:format
              completionHandler: ^(GenerateReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var generateUnitedOrdersRequest = ; // {GenerateUnitedOrdersRequest} 
var opts = {
  'format':  // {ReportFormatType} Формат отчета.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateUnitedOrdersReport(generateUnitedOrdersRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class generateUnitedOrdersReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var generateUnitedOrdersRequest = new GenerateUnitedOrdersRequest(); // GenerateUnitedOrdersRequest | 
            var format = new ReportFormatType(); // ReportFormatType | Формат отчета. (optional)  (default to null)

            try {
                // Отчет по заказам
                GenerateReportResponse result = apiInstance.generateUnitedOrdersReport(generateUnitedOrdersRequest, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.generateUnitedOrdersReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest | 
$format = ; // ReportFormatType | Формат отчета.

try {
    $result = $api_instance->generateUnitedOrdersReport($generateUnitedOrdersRequest, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $generateUnitedOrdersRequest = WWW::OPenAPIClient::Object::GenerateUnitedOrdersRequest->new(); # GenerateUnitedOrdersRequest | 
my $format = ; # ReportFormatType | Формат отчета.

eval {
    my $result = $api_instance->generateUnitedOrdersReport(generateUnitedOrdersRequest => $generateUnitedOrdersRequest, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->generateUnitedOrdersReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
generateUnitedOrdersRequest =  # GenerateUnitedOrdersRequest | 
format =  # ReportFormatType | Формат отчета. (optional) (default to null)

try:
    # Отчет по заказам
    api_response = api_instance.generate_united_orders_report(generateUnitedOrdersRequest, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->generateUnitedOrdersReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let generateUnitedOrdersRequest = ; // GenerateUnitedOrdersRequest
    let format = ; // ReportFormatType

    let mut context = ReportsApi::Context::default();
    let result = client.generateUnitedOrdersReport(generateUnitedOrdersRequest, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
generateUnitedOrdersRequest *

Query parameters
Name Description
format
ReportFormatType
Формат отчета.

Responses


getReportInfo

Получение заданного отчета

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. [Инструкция](../../step-by-step/reports.md) |**⚙️ Лимит:** 100 запросов в минуту| |-|


/reports/info/{reportId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/reports/info/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportId = new String(); // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    final result = await api_instance.getReportInfo(reportId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReportInfo: $e\n');
}

import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


        try {
            GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
String *reportId = reportId_example; // Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

// Получение заданного отчета
[apiInstance getReportInfoWith:reportId
              completionHandler: ^(GetReportInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReportsApi()
var reportId = reportId_example; // {String} Идентификатор отчета, который вы получили после запуска генерации.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportInfo(reportId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReportInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var reportId = reportId_example;  // String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

            try {
                // Получение заданного отчета
                GetReportInfoResponse result = apiInstance.getReportInfo(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.getReportInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$reportId = reportId_example; // String | Идентификатор отчета, который вы получили после запуска генерации.


try {
    $result = $api_instance->getReportInfo($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReportInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $reportId = reportId_example; # String | Идентификатор отчета, который вы получили после запуска генерации.


eval {
    my $result = $api_instance->getReportInfo(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReportInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
reportId = reportId_example # String | Идентификатор отчета, который вы получили после запуска генерации.
 (default to null)

try:
    # Получение заданного отчета
    api_response = api_instance.get_report_info(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getReportInfo: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let reportId = reportId_example; // String

    let mut context = ReportsApi::Context::default();
    let result = client.getReportInfo(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
reportId*
String
Идентификатор отчета, который вы получили после запуска генерации.
Required

Responses


Returns

getReturn

Информация о невыкупе или возврате

Получает информацию по одному невыкупу или возврату. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturn");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturn(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturn: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Информация о невыкупе или возврате
[apiInstance getReturnWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(GetReturnResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturn(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Информация о невыкупе или возврате
                GetReturnResponse result = apiInstance.getReturn(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.getReturn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturn($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturn(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Информация о невыкупе или возврате
    api_response = api_instance.get_return(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->getReturn: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = ReturnsApi::Context::default();
    let result = client.getReturn(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnApplication

Получение заявления на возврат

Загружает заявление покупателя на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.getReturnApplication(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnApplication: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturnApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Получение заявления на возврат
[apiInstance getReturnApplicationWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnApplication(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnApplicationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Получение заявления на возврат
                File result = apiInstance.getReturnApplication(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.getReturnApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->getReturnApplication($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturnApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->getReturnApplication(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->getReturnApplication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Получение заявления на возврат
    api_response = api_instance.get_return_application(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->getReturnApplication: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = ReturnsApi::Context::default();
    let result = client.getReturnApplication(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


getReturnPhoto

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/octet-stream,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final Long itemId = new Long(); // Long | Идентификатор товара в возврате.
final String imageHash = new String(); // String | Хеш ссылки изображения для загрузки.

try {
    final result = await api_instance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturnPhoto: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        Long itemId = 789; // Long | Идентификатор товара в возврате.
        String imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

        try {
            File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturnPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
Long *itemId = 789; // Идентификатор товара в возврате. (default to null)
String *imageHash = imageHash_example; // Хеш ссылки изображения для загрузки. (default to null)

// Получение фотографии возврата
[apiInstance getReturnPhotoWith:campaignId
    orderId:orderId
    returnId:returnId
    itemId:itemId
    imageHash:imageHash
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var itemId = 789; // {Long} Идентификатор товара в возврате.
var imageHash = imageHash_example; // {String} Хеш ссылки изображения для загрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnPhotoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var itemId = 789;  // Long | Идентификатор товара в возврате. (default to null)
            var imageHash = imageHash_example;  // String | Хеш ссылки изображения для загрузки. (default to null)

            try {
                // Получение фотографии возврата
                File result = apiInstance.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.getReturnPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$itemId = 789; // Long | Идентификатор товара в возврате.
$imageHash = imageHash_example; // String | Хеш ссылки изображения для загрузки.

try {
    $result = $api_instance->getReturnPhoto($campaignId, $orderId, $returnId, $itemId, $imageHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $itemId = 789; # Long | Идентификатор товара в возврате.
my $imageHash = imageHash_example; # String | Хеш ссылки изображения для загрузки.

eval {
    my $result = $api_instance->getReturnPhoto(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, itemId => $itemId, imageHash => $imageHash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->getReturnPhoto: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
itemId = 789 # Long | Идентификатор товара в возврате. (default to null)
imageHash = imageHash_example # String | Хеш ссылки изображения для загрузки. (default to null)

try:
    # Получение фотографии возврата
    api_response = api_instance.get_return_photo(campaignId, orderId, returnId, itemId, imageHash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->getReturnPhoto: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let itemId = 789; // Long
    let imageHash = imageHash_example; // String

    let mut context = ReturnsApi::Context::default();
    let result = client.getReturnPhoto(campaignId, orderId, returnId, itemId, imageHash, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
itemId*
Long (int64)
Идентификатор товара в возврате.
Required
imageHash*
String
Хеш ссылки изображения для загрузки.
Required

Responses


getReturns

Список невыкупов и возвратов

Получает список невыкупов и возвратов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос [GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}](../../reference/orders/getReturn.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/returns

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20&orderIds=&statuses=STARTED_BY_USER,WAITING_FOR_DECISION&type=&fromDate=2022-10-31&toDate=2022-11-30&from_date=2022-10-31&to_date=2022-11-30"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturns");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final array[Long] orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

final array[RefundStatusType] statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

final ReturnType type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

final date fromDate = new date(); // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date toDate = new date(); // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

final date fromDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

final date toDate2 = new date(); // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    final result = await api_instance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReturns: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        array[Long] orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

        array[RefundStatusType] statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

        ReturnType type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

        date fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

        date fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

        date toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


        try {
            GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#getReturns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
array[Long] *orderIds = ; // Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
array[RefundStatusType] *statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
ReturnType *type = ; // Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
date *fromDate = 2022-10-31; // Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *toDate = 2022-11-30; // Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
date *fromDate2 = 2022-10-31; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
date *toDate2 = 2022-11-30; // {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

// Список невыкупов и возвратов
[apiInstance getReturnsWith:campaignId
    pageToken:pageToken
    limit:limit
    orderIds:orderIds
    statuses:statuses
    type:type
    fromDate:fromDate
    toDate:toDate
    fromDate2:fromDate2
    toDate2:toDate2
              completionHandler: ^(GetReturnsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'orderIds': , // {array[Long]} Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

  'statuses': STARTED_BY_USER,WAITING_FOR_DECISION, // {array[RefundStatusType]} Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

  'type': , // {ReturnType} Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

  'fromDate': 2022-10-31, // {date} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'toDate': 2022-11-30, // {date} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

  'fromDate2': 2022-10-31, // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

  'toDate2': 2022-11-30 // {date} {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturns(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getReturnsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var orderIds = new array[Long](); // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional)  (default to null)
            var statuses = new array[RefundStatusType](); // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional)  (default to null)
            var type = new ReturnType(); // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional)  (default to null)
            var fromDate = 2022-10-31;  // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var toDate = 2022-11-30;  // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional)  (default to null)
            var fromDate2 = 2022-10-31;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)
            var toDate2 = 2022-11-30;  // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional)  (default to null)

            try {
                // Список невыкупов и возвратов
                GetReturnsResponse result = apiInstance.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.getReturns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$orderIds = ; // array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

$type = ; // ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

$fromDate = 2022-10-31; // date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$toDate = 2022-11-30; // date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

$fromDate2 = 2022-10-31; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

$toDate2 = 2022-11-30; // date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


try {
    $result = $api_instance->getReturns($campaignId, $pageToken, $limit, $orderIds, $statuses, $type, $fromDate, $toDate, $fromDate2, $toDate2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $orderIds = []; # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

my $statuses = [STARTED_BY_USER,WAITING_FOR_DECISION]; # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

my $type = ; # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

my $fromDate = 2022-10-31; # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $toDate = 2022-11-30; # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.

my $fromDate2 = 2022-10-31; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

my $toDate2 = 2022-11-30; # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.


eval {
    my $result = $api_instance->getReturns(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, orderIds => $orderIds, statuses => $statuses, type => $type, fromDate => $fromDate, toDate => $toDate, fromDate2 => $fromDate2, toDate2 => $toDate2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->getReturns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
orderIds =  # array[Long] | Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
 (optional) (default to null)
statuses = STARTED_BY_USER,WAITING_FOR_DECISION # array[RefundStatusType] | Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
 (optional) (default to null)
type =  # ReturnType | Тип заказа для фильтрации:

* `RETURN` — возврат.

* `UNREDEEMED` — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.
 (optional) (default to null)
fromDate = 2022-10-31 # date | Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
toDate = 2022-11-30 # date | Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: `ГГГГ-ММ-ДД`.
 (optional) (default to null)
fromDate2 = 2022-10-31 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `fromDate`.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)
toDate2 = 2022-11-30 # date | {% note warning "" %}

Этот параметр устарел. Вместо него используйте `toDate`.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
 (optional) (default to null)

try:
    # Список невыкупов и возвратов
    api_response = api_instance.get_returns(campaignId, pageToken=pageToken, limit=limit, orderIds=orderIds, statuses=statuses, type=type, fromDate=fromDate, toDate=toDate, fromDate2=fromDate2, toDate2=toDate2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->getReturns: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let orderIds = ; // array[Long]
    let statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // array[RefundStatusType]
    let type = ; // ReturnType
    let fromDate = 2022-10-31; // date
    let toDate = 2022-11-30; // date
    let fromDate2 = 2022-10-31; // date
    let toDate2 = 2022-11-30; // date

    let mut context = ReturnsApi::Context::default();
    let result = client.getReturns(campaignId, pageToken, limit, orderIds, statuses, type, fromDate, toDate, fromDate2, toDate2, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.
orderIds
array[Long] (int64)
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
statuses
array[RefundStatusType]
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
type
ReturnType
Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.
fromDate
date (date)
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
toDate
date (date)
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: `ГГГГ-ММ-ДД`.
from_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `fromDate`. {% endnote %} Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
to_date
date (date)
{% note warning "" %} Этот параметр устарел. Вместо него используйте `toDate`. {% endnote %} Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Responses


setReturnDecision

Принятие или изменение решения по возврату

Выбирает решение по возврату от покупателя. После этого для подтверждения решения нужно выполнить запрос [POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit](../../reference/orders/submitReturnDecision.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision" \
 -d '{
  "returnItemId" : 1,
  "decisionType" : "REFUND_MONEY_INCLUDING_SHIPMENT",
  "comment" : "Вернуть 149 рублей за пересылку"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        SetReturnDecisionRequest setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

        try {
            EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#setReturnDecision");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.
final SetReturnDecisionRequest setReturnDecisionRequest = new SetReturnDecisionRequest(); // SetReturnDecisionRequest | 

try {
    final result = await api_instance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setReturnDecision: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.
        SetReturnDecisionRequest setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

        try {
            EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#setReturnDecision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)
SetReturnDecisionRequest *setReturnDecisionRequest = ; // 

// Принятие или изменение решения по возврату
[apiInstance setReturnDecisionWith:campaignId
    orderId:orderId
    returnId:returnId
    setReturnDecisionRequest:setReturnDecisionRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.
var setReturnDecisionRequest = ; // {SetReturnDecisionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setReturnDecisionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)
            var setReturnDecisionRequest = new SetReturnDecisionRequest(); // SetReturnDecisionRequest | 

            try {
                // Принятие или изменение решения по возврату
                EmptyApiResponse result = apiInstance.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.setReturnDecision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.
$setReturnDecisionRequest = ; // SetReturnDecisionRequest | 

try {
    $result = $api_instance->setReturnDecision($campaignId, $orderId, $returnId, $setReturnDecisionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->setReturnDecision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.
my $setReturnDecisionRequest = WWW::OPenAPIClient::Object::SetReturnDecisionRequest->new(); # SetReturnDecisionRequest | 

eval {
    my $result = $api_instance->setReturnDecision(campaignId => $campaignId, orderId => $orderId, returnId => $returnId, setReturnDecisionRequest => $setReturnDecisionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->setReturnDecision: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)
setReturnDecisionRequest =  # SetReturnDecisionRequest | 

try:
    # Принятие или изменение решения по возврату
    api_response = api_instance.set_return_decision(campaignId, orderId, returnId, setReturnDecisionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->setReturnDecision: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long
    let setReturnDecisionRequest = ; // SetReturnDecisionRequest

    let mut context = ReturnsApi::Context::default();
    let result = client.setReturnDecision(campaignId, orderId, returnId, setReturnDecisionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required
Body parameters
Name Description
setReturnDecisionRequest *

Responses


submitReturnDecision

Подтверждение решения по возврату

Подтверждает выбранное решение по возврату, отправленное в запросе [POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision](../../reference/orders/setReturnDecision.md). |**⚙️ Лимит:** 10 000 запросов в час| |-|


/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReturnsApi;

import java.io.File;
import java.util.*;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#submitReturnDecision");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long orderId = new Long(); // Long | Идентификатор заказа.
final Long returnId = new Long(); // Long | Идентификатор возврата.

try {
    final result = await api_instance.submitReturnDecision(campaignId, orderId, returnId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->submitReturnDecision: $e\n');
}

import org.openapitools.client.api.ReturnsApi;

public class ReturnsApiExample {
    public static void main(String[] args) {
        ReturnsApi apiInstance = new ReturnsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long orderId = 789; // Long | Идентификатор заказа.
        Long returnId = 789; // Long | Идентификатор возврата.

        try {
            EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnsApi#submitReturnDecision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ReturnsApi *apiInstance = [[ReturnsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *orderId = 789; // Идентификатор заказа. (default to null)
Long *returnId = 789; // Идентификатор возврата. (default to null)

// Подтверждение решения по возврату
[apiInstance submitReturnDecisionWith:campaignId
    orderId:orderId
    returnId:returnId
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ReturnsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var orderId = 789; // {Long} Идентификатор заказа.
var returnId = 789; // {Long} Идентификатор возврата.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitReturnDecision(campaignId, orderId, returnId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class submitReturnDecisionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ReturnsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var orderId = 789;  // Long | Идентификатор заказа. (default to null)
            var returnId = 789;  // Long | Идентификатор возврата. (default to null)

            try {
                // Подтверждение решения по возврату
                EmptyApiResponse result = apiInstance.submitReturnDecision(campaignId, orderId, returnId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReturnsApi.submitReturnDecision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReturnsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$orderId = 789; // Long | Идентификатор заказа.
$returnId = 789; // Long | Идентификатор возврата.

try {
    $result = $api_instance->submitReturnDecision($campaignId, $orderId, $returnId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->submitReturnDecision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReturnsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReturnsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $orderId = 789; # Long | Идентификатор заказа.
my $returnId = 789; # Long | Идентификатор возврата.

eval {
    my $result = $api_instance->submitReturnDecision(campaignId => $campaignId, orderId => $orderId, returnId => $returnId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnsApi->submitReturnDecision: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ReturnsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
orderId = 789 # Long | Идентификатор заказа. (default to null)
returnId = 789 # Long | Идентификатор возврата. (default to null)

try:
    # Подтверждение решения по возврату
    api_response = api_instance.submit_return_decision(campaignId, orderId, returnId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnsApi->submitReturnDecision: %s\n" % e)
extern crate ReturnsApi;

pub fn main() {
    let campaignId = 789; // Long
    let orderId = 789; // Long
    let returnId = 789; // Long

    let mut context = ReturnsApi::Context::default();
    let result = client.submitReturnDecision(campaignId, orderId, returnId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
orderId*
Long (int64)
Идентификатор заказа.
Required
returnId*
Long (int64)
Идентификатор возврата.
Required

Responses


Shipments

confirmShipment

Подтверждение отгрузки

Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm" \
 -d '{
  "externalShipmentId" : "externalShipmentId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ConfirmShipmentRequest confirmShipmentRequest = ; // ConfirmShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#confirmShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final ConfirmShipmentRequest confirmShipmentRequest = new ConfirmShipmentRequest(); // ConfirmShipmentRequest | 

try {
    final result = await api_instance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirmShipment: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ConfirmShipmentRequest confirmShipmentRequest = ; // ConfirmShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#confirmShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
ConfirmShipmentRequest *confirmShipmentRequest = ; //  (optional)

// Подтверждение отгрузки
[apiInstance confirmShipmentWith:campaignId
    shipmentId:shipmentId
    confirmShipmentRequest:confirmShipmentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'confirmShipmentRequest':  // {ConfirmShipmentRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmShipment(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class confirmShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var confirmShipmentRequest = new ConfirmShipmentRequest(); // ConfirmShipmentRequest |  (optional) 

            try {
                // Подтверждение отгрузки
                EmptyApiResponse result = apiInstance.confirmShipment(campaignId, shipmentId, confirmShipmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.confirmShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$confirmShipmentRequest = ; // ConfirmShipmentRequest | 

try {
    $result = $api_instance->confirmShipment($campaignId, $shipmentId, $confirmShipmentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->confirmShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $confirmShipmentRequest = WWW::OPenAPIClient::Object::ConfirmShipmentRequest->new(); # ConfirmShipmentRequest | 

eval {
    my $result = $api_instance->confirmShipment(campaignId => $campaignId, shipmentId => $shipmentId, confirmShipmentRequest => $confirmShipmentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->confirmShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
confirmShipmentRequest =  # ConfirmShipmentRequest |  (optional)

try:
    # Подтверждение отгрузки
    api_response = api_instance.confirm_shipment(campaignId, shipmentId, confirmShipmentRequest=confirmShipmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->confirmShipment: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let confirmShipmentRequest = ; // ConfirmShipmentRequest

    let mut context = ShipmentsApi::Context::default();
    let result = client.confirmShipment(campaignId, shipmentId, confirmShipmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
confirmShipmentRequest

Responses


downloadShipmentAct

Получение акта приема-передачи

{% note warning "Экспресс‑доставка" %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно. {% endnote %} Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | **Данные в акте** | **Описание** | | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Дата | Дата запроса. | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос [POST order/accept](../../pushapi/reference/orderAccept.md) от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentAct: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение акта приема-передачи
[apiInstance downloadShipmentActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение акта приема-передачи
                File result = apiInstance.downloadShipmentAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение акта приема-передачи
    api_response = api_instance.download_shipment_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentAct: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentDiscrepancyAct

Получение акта расхождений

Возвращает акт расхождений для заданной отгрузки. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.ms-excel,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentDiscrepancyAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentDiscrepancyAct: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentDiscrepancyAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение акта расхождений
[apiInstance downloadShipmentDiscrepancyActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentDiscrepancyAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentDiscrepancyActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение акта расхождений
                File result = apiInstance.downloadShipmentDiscrepancyAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentDiscrepancyAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentDiscrepancyAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentDiscrepancyAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentDiscrepancyAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentDiscrepancyAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение акта расхождений
    api_response = api_instance.download_shipment_discrepancy_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentDiscrepancyAct: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentDiscrepancyAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentInboundAct

Получение фактического акта приема-передачи

Возвращает фактический акт приема-передачи для заданной отгрузки. Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentInboundAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentInboundAct(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentInboundAct: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentInboundAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение фактического акта приема-передачи
[apiInstance downloadShipmentInboundActWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentInboundAct(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentInboundActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение фактического акта приема-передачи
                File result = apiInstance.downloadShipmentInboundAct(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentInboundAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentInboundAct($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentInboundAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentInboundAct(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentInboundAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение фактического акта приема-передачи
    api_response = api_instance.download_shipment_inbound_act(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentInboundAct: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentInboundAct(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


downloadShipmentPalletLabels

Ярлыки для доверительной приемки (FBS)

PDF-файл с ярлыками на каждый короб или палету в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в [Справке Маркета](https://yandex.ru/support/marketplace/orders/fbs/process.html#acceptance). Распечатайте по несколько копий каждого ярлыка: на одну тару нужно наклеить минимум 2 ярлыка с разных сторон. Количество упаковок в отгрузке задается в запросе [PUT campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets](../../reference/shipments/setShipmentPalletsCount.md). |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels?format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ShipmentPalletLabelPageFormatType format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


        try {
            File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentPalletLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final ShipmentPalletLabelPageFormatType format = new ShipmentPalletLabelPageFormatType(); // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


try {
    final result = await api_instance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentPalletLabels: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        ShipmentPalletLabelPageFormatType format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


        try {
            File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentPalletLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
ShipmentPalletLabelPageFormatType *format = ; // Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional) (default to null)

// Ярлыки для доверительной приемки (FBS)
[apiInstance downloadShipmentPalletLabelsWith:campaignId
    shipmentId:shipmentId
    format:format
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'format':  // {ShipmentPalletLabelPageFormatType} Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentPalletLabels(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentPalletLabelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var format = new ShipmentPalletLabelPageFormatType(); // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional)  (default to null)

            try {
                // Ярлыки для доверительной приемки (FBS)
                File result = apiInstance.downloadShipmentPalletLabels(campaignId, shipmentId, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentPalletLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$format = ; // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


try {
    $result = $api_instance->downloadShipmentPalletLabels($campaignId, $shipmentId, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentPalletLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $format = ; # ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.


eval {
    my $result = $api_instance->downloadShipmentPalletLabels(campaignId => $campaignId, shipmentId => $shipmentId, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentPalletLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
format =  # ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками:

* `A4` — по 16 ярлыков на странице.
* `A8` — по одному ярлыку на странице.
 (optional) (default to null)

try:
    # Ярлыки для доверительной приемки (FBS)
    api_response = api_instance.download_shipment_pallet_labels(campaignId, shipmentId, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentPalletLabels: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let format = ; // ShipmentPalletLabelPageFormatType

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentPalletLabels(campaignId, shipmentId, format, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Query parameters
Name Description
format
ShipmentPalletLabelPageFormatType
Формат страниц PDF-файла с ярлыками: * `A4` — по 16 ярлыков на странице. * `A8` — по одному ярлыку на странице.

Responses


downloadShipmentReceptionTransferAct

Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее

Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF. {% note warning "Экспресс‑доставка" %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам [Яндекс Go](https://go.yandex/), подготавливать акт приема‑передачи не нужно. {% endnote %} В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | **Данные в акте** | **Описание** | | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос [POST order/accept](../../pushapi/reference/orderAccept.md) от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md). | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса [GET campaigns/{campaignId}/orders](../../reference/orders/getOrders.md) или [GET campaigns/{campaignId}/orders/{orderId}](../../reference/orders/getOrder.md). | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/shipments/reception-transfer-act

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/pdf,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/shipments/reception-transfer-act?warehouse_id=123123"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Integer warehouseId = 123123; // Integer | Идентификатор склада.

        try {
            File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentReceptionTransferAct");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Integer warehouseId = new Integer(); // Integer | Идентификатор склада.

try {
    final result = await api_instance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentReceptionTransferAct: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Integer warehouseId = 123123; // Integer | Идентификатор склада.

        try {
            File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentReceptionTransferAct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Integer *warehouseId = 123123; // Идентификатор склада. (optional) (default to null)

// Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
[apiInstance downloadShipmentReceptionTransferActWith:campaignId
    warehouseId:warehouseId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'warehouseId': 123123 // {Integer} Идентификатор склада.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentReceptionTransferAct(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentReceptionTransferActExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var warehouseId = 123123;  // Integer | Идентификатор склада. (optional)  (default to null)

            try {
                // Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
                File result = apiInstance.downloadShipmentReceptionTransferAct(campaignId, warehouseId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentReceptionTransferAct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$warehouseId = 123123; // Integer | Идентификатор склада.

try {
    $result = $api_instance->downloadShipmentReceptionTransferAct($campaignId, $warehouseId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentReceptionTransferAct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $warehouseId = 123123; # Integer | Идентификатор склада.

eval {
    my $result = $api_instance->downloadShipmentReceptionTransferAct(campaignId => $campaignId, warehouseId => $warehouseId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentReceptionTransferAct: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
warehouseId = 123123 # Integer | Идентификатор склада. (optional) (default to null)

try:
    # Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
    api_response = api_instance.download_shipment_reception_transfer_act(campaignId, warehouseId=warehouseId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentReceptionTransferAct: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let warehouseId = 123123; // Integer

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentReceptionTransferAct(campaignId, warehouseId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Query parameters
Name Description
warehouse_id
Integer (int32)
Идентификатор склада.

Responses


downloadShipmentTransportationWaybill

Получение транспортной накладной

Возвращает транспортную накладную для заданной отгрузки. Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. [Подробно об этом способе отгрузки](https://yandex.ru/support/marketplace/orders/fbs/settings/shipment.html#at-your-warehouse) |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.ms-excel,application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentTransportationWaybill");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadShipmentTransportationWaybill: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#downloadShipmentTransportationWaybill");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение транспортной накладной
[apiInstance downloadShipmentTransportationWaybillWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadShipmentTransportationWaybill(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class downloadShipmentTransportationWaybillExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение транспортной накладной
                File result = apiInstance.downloadShipmentTransportationWaybill(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.downloadShipmentTransportationWaybill: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->downloadShipmentTransportationWaybill($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->downloadShipmentTransportationWaybill: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->downloadShipmentTransportationWaybill(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->downloadShipmentTransportationWaybill: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение транспортной накладной
    api_response = api_instance.download_shipment_transportation_waybill(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->downloadShipmentTransportationWaybill: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = ShipmentsApi::Context::default();
    let result = client.downloadShipmentTransportationWaybill(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


getShipment

Получение информации об одной отгрузке

Возвращает информацию об отгрузке по ее идентификатору. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}?cancelledOrders=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        Boolean cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


        try {
            GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#getShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final Boolean cancelledOrders = new Boolean(); // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


try {
    final result = await api_instance.getShipment(campaignId, shipmentId, cancelledOrders);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getShipment: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        Boolean cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


        try {
            GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#getShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
Boolean *cancelledOrders = true; // Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional) (default to true)

// Получение информации об одной отгрузке
[apiInstance getShipmentWith:campaignId
    shipmentId:shipmentId
    cancelledOrders:cancelledOrders
              completionHandler: ^(GetShipmentResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var opts = {
  'cancelledOrders': true // {Boolean} Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShipment(campaignId, shipmentId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var cancelledOrders = true;  // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional)  (default to true)

            try {
                // Получение информации об одной отгрузке
                GetShipmentResponse result = apiInstance.getShipment(campaignId, shipmentId, cancelledOrders);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.getShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$cancelledOrders = true; // Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


try {
    $result = $api_instance->getShipment($campaignId, $shipmentId, $cancelledOrders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->getShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $cancelledOrders = true; # Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.


eval {
    my $result = $api_instance->getShipment(campaignId => $campaignId, shipmentId => $shipmentId, cancelledOrders => $cancelledOrders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->getShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
cancelledOrders = true # Boolean | Возвращать ли отмененные заказы.

Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.
 (optional) (default to true)

try:
    # Получение информации об одной отгрузке
    api_response = api_instance.get_shipment(campaignId, shipmentId, cancelledOrders=cancelledOrders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->getShipment: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let cancelledOrders = true; // Boolean

    let mut context = ShipmentsApi::Context::default();
    let result = client.getShipment(campaignId, shipmentId, cancelledOrders, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Query parameters
Name Description
cancelledOrders
Boolean
Возвращать ли отмененные заказы. Значение по умолчанию — `true`. Если возвращать отмененные заказы не нужно, передайте значение `false`.

Responses


getShipmentOrdersInfo

Получение информации о возможности печати ярлыков (FBS)

Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#getShipmentOrdersInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.

try {
    final result = await api_instance.getShipmentOrdersInfo(campaignId, shipmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getShipmentOrdersInfo: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.

        try {
            GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#getShipmentOrdersInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)

// Получение информации о возможности печати ярлыков (FBS)
[apiInstance getShipmentOrdersInfoWith:campaignId
    shipmentId:shipmentId
              completionHandler: ^(GetShipmentOrdersInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShipmentOrdersInfo(campaignId, shipmentId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getShipmentOrdersInfoExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)

            try {
                // Получение информации о возможности печати ярлыков (FBS)
                GetShipmentOrdersInfoResponse result = apiInstance.getShipmentOrdersInfo(campaignId, shipmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.getShipmentOrdersInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.

try {
    $result = $api_instance->getShipmentOrdersInfo($campaignId, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->getShipmentOrdersInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.

eval {
    my $result = $api_instance->getShipmentOrdersInfo(campaignId => $campaignId, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->getShipmentOrdersInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)

try:
    # Получение информации о возможности печати ярлыков (FBS)
    api_response = api_instance.get_shipment_orders_info(campaignId, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->getShipmentOrdersInfo: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long

    let mut context = ShipmentsApi::Context::default();
    let result = client.getShipmentOrdersInfo(campaignId, shipmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required

Responses


searchShipments

Получение информации о нескольких отгрузках

Возвращает информацию об отгрузках по заданным параметрам: * дате; * статусу; * идентификаторам заказов. Результаты возвращаются постранично. |**⚙️ Лимит:** 100 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "cancelledOrders" : true,
  "dateTo" : "2000-01-23",
  "statuses" : [ "OUTBOUND_CREATED", "OUTBOUND_CREATED" ],
  "orderIds" : [ 0, 0 ],
  "dateFrom" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SearchShipmentsRequest searchShipmentsRequest = ; // SearchShipmentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#searchShipments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final SearchShipmentsRequest searchShipmentsRequest = new SearchShipmentsRequest(); // SearchShipmentsRequest | 
final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.


try {
    final result = await api_instance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchShipments: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        SearchShipmentsRequest searchShipmentsRequest = ; // SearchShipmentsRequest | 
        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.


        try {
            SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#searchShipments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
SearchShipmentsRequest *searchShipmentsRequest = ; // 
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)

// Получение информации о нескольких отгрузках
[apiInstance searchShipmentsWith:campaignId
    searchShipmentsRequest:searchShipmentsRequest
    pageToken:pageToken
    limit:limit
              completionHandler: ^(SearchShipmentsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var searchShipmentsRequest = ; // {SearchShipmentsRequest} 
var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20 // {Integer} Количество значений на одной странице.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchShipments(campaignId, searchShipmentsRequest, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class searchShipmentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var searchShipmentsRequest = new SearchShipmentsRequest(); // SearchShipmentsRequest | 
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)

            try {
                // Получение информации о нескольких отгрузках
                SearchShipmentsResponse result = apiInstance.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.searchShipments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$searchShipmentsRequest = ; // SearchShipmentsRequest | 
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.


try {
    $result = $api_instance->searchShipments($campaignId, $searchShipmentsRequest, $pageToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->searchShipments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $searchShipmentsRequest = WWW::OPenAPIClient::Object::SearchShipmentsRequest->new(); # SearchShipmentsRequest | 
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.


eval {
    my $result = $api_instance->searchShipments(campaignId => $campaignId, searchShipmentsRequest => $searchShipmentsRequest, pageToken => $pageToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->searchShipments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
searchShipmentsRequest =  # SearchShipmentsRequest | 
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)

try:
    # Получение информации о нескольких отгрузках
    api_response = api_instance.search_shipments(campaignId, searchShipmentsRequest, pageToken=pageToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->searchShipments: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let searchShipmentsRequest = ; // SearchShipmentsRequest
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer

    let mut context = ShipmentsApi::Context::default();
    let result = client.searchShipments(campaignId, searchShipmentsRequest, pageToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
searchShipmentsRequest *

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


setShipmentPalletsCount

Передача количества упаковок в отгрузке

Передает Маркету количество коробов или палет в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в [Справке Маркета](https://yandex.ru/support/marketplace/orders/fbs/process.html#acceptance). Получить PDF-файл с ярлыками для упаковок можно с помощью запроса [GET campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels](../../reference/shipments/downloadShipmentPalletLabels.md). |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets" \
 -d '{
  "placesCount" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

        try {
            EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#setShipmentPalletsCount");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = new SetShipmentPalletsCountRequest(); // SetShipmentPalletsCountRequest | 

try {
    final result = await api_instance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setShipmentPalletsCount: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        SetShipmentPalletsCountRequest setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

        try {
            EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#setShipmentPalletsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
SetShipmentPalletsCountRequest *setShipmentPalletsCountRequest = ; // 

// Передача количества упаковок в отгрузке
[apiInstance setShipmentPalletsCountWith:campaignId
    shipmentId:shipmentId
    setShipmentPalletsCountRequest:setShipmentPalletsCountRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var setShipmentPalletsCountRequest = ; // {SetShipmentPalletsCountRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class setShipmentPalletsCountExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var setShipmentPalletsCountRequest = new SetShipmentPalletsCountRequest(); // SetShipmentPalletsCountRequest | 

            try {
                // Передача количества упаковок в отгрузке
                EmptyApiResponse result = apiInstance.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.setShipmentPalletsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest | 

try {
    $result = $api_instance->setShipmentPalletsCount($campaignId, $shipmentId, $setShipmentPalletsCountRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->setShipmentPalletsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $setShipmentPalletsCountRequest = WWW::OPenAPIClient::Object::SetShipmentPalletsCountRequest->new(); # SetShipmentPalletsCountRequest | 

eval {
    my $result = $api_instance->setShipmentPalletsCount(campaignId => $campaignId, shipmentId => $shipmentId, setShipmentPalletsCountRequest => $setShipmentPalletsCountRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->setShipmentPalletsCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
setShipmentPalletsCountRequest =  # SetShipmentPalletsCountRequest | 

try:
    # Передача количества упаковок в отгрузке
    api_response = api_instance.set_shipment_pallets_count(campaignId, shipmentId, setShipmentPalletsCountRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->setShipmentPalletsCount: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let setShipmentPalletsCountRequest = ; // SetShipmentPalletsCountRequest

    let mut context = ShipmentsApi::Context::default();
    let result = client.setShipmentPalletsCount(campaignId, shipmentId, setShipmentPalletsCountRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
setShipmentPalletsCountRequest *

Responses


transferOrdersFromShipment

Перенос заказов в следующую отгрузку

Переносит указанные заказы из указанной отгрузки в следующую отгрузку. [Что такое отгрузка?](https://yandex.ru/support/marketplace/orders/fbs/process.html#ship) Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя. {% note warning "Такие переносы снижают индекс качества магазина" %} Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. [Что за ограничения?](https://yandex.ru/support/marketplace/quality/score/fbs.html) {% endnote %} Переносить заказы можно, если до формирования отгрузки осталось больше получаса. Перенос происходит не мгновенно, а занимает несколько минут. |**⚙️ Лимит:** 200 запросов в час| |-|


/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer" \
 -d '{
  "orderIds" : [ 0, 0, 0, 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ShipmentsApi;

import java.io.File;
import java.util.*;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#transferOrdersFromShipment");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final Long shipmentId = new Long(); // Long | Идентификатор отгрузки.
final TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = new TransferOrdersFromShipmentRequest(); // TransferOrdersFromShipmentRequest | 

try {
    final result = await api_instance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->transferOrdersFromShipment: $e\n');
}

import org.openapitools.client.api.ShipmentsApi;

public class ShipmentsApiExample {
    public static void main(String[] args) {
        ShipmentsApi apiInstance = new ShipmentsApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        Long shipmentId = 789; // Long | Идентификатор отгрузки.
        TransferOrdersFromShipmentRequest transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

        try {
            EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentsApi#transferOrdersFromShipment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ShipmentsApi *apiInstance = [[ShipmentsApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
Long *shipmentId = 789; // Идентификатор отгрузки. (default to null)
TransferOrdersFromShipmentRequest *transferOrdersFromShipmentRequest = ; // 

// Перенос заказов в следующую отгрузку
[apiInstance transferOrdersFromShipmentWith:campaignId
    shipmentId:shipmentId
    transferOrdersFromShipmentRequest:transferOrdersFromShipmentRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.ShipmentsApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var shipmentId = 789; // {Long} Идентификатор отгрузки.
var transferOrdersFromShipmentRequest = ; // {TransferOrdersFromShipmentRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class transferOrdersFromShipmentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ShipmentsApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var shipmentId = 789;  // Long | Идентификатор отгрузки. (default to null)
            var transferOrdersFromShipmentRequest = new TransferOrdersFromShipmentRequest(); // TransferOrdersFromShipmentRequest | 

            try {
                // Перенос заказов в следующую отгрузку
                EmptyApiResponse result = apiInstance.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ShipmentsApi.transferOrdersFromShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ShipmentsApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$shipmentId = 789; // Long | Идентификатор отгрузки.
$transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest | 

try {
    $result = $api_instance->transferOrdersFromShipment($campaignId, $shipmentId, $transferOrdersFromShipmentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->transferOrdersFromShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ShipmentsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ShipmentsApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $shipmentId = 789; # Long | Идентификатор отгрузки.
my $transferOrdersFromShipmentRequest = WWW::OPenAPIClient::Object::TransferOrdersFromShipmentRequest->new(); # TransferOrdersFromShipmentRequest | 

eval {
    my $result = $api_instance->transferOrdersFromShipment(campaignId => $campaignId, shipmentId => $shipmentId, transferOrdersFromShipmentRequest => $transferOrdersFromShipmentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentsApi->transferOrdersFromShipment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ShipmentsApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
shipmentId = 789 # Long | Идентификатор отгрузки. (default to null)
transferOrdersFromShipmentRequest =  # TransferOrdersFromShipmentRequest | 

try:
    # Перенос заказов в следующую отгрузку
    api_response = api_instance.transfer_orders_from_shipment(campaignId, shipmentId, transferOrdersFromShipmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentsApi->transferOrdersFromShipment: %s\n" % e)
extern crate ShipmentsApi;

pub fn main() {
    let campaignId = 789; // Long
    let shipmentId = 789; // Long
    let transferOrdersFromShipmentRequest = ; // TransferOrdersFromShipmentRequest

    let mut context = ShipmentsApi::Context::default();
    let result = client.transferOrdersFromShipment(campaignId, shipmentId, transferOrdersFromShipmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
shipmentId*
Long (int64)
Идентификатор отгрузки.
Required
Body parameters
Name Description
transferOrdersFromShipmentRequest *

Responses


Stocks

getStocks

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для всех моделей) и об [оборачиваемости](*turnover) товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте `true` в поле `withTurnover`. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке Маркета для продавцов https://yandex.ru/support/marketplace/analytics/turnover.html.)


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
 -d '{
  "archived" : true,
  "withTurnover" : false,
  "offerIds" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StocksApi;

import java.io.File;
import java.util.*;

public class StocksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        StocksApi apiInstance = new StocksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StocksApi#getStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final String pageToken = new String(); // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

final Integer limit = new Integer(); // Integer | Количество значений на одной странице.

final GetWarehouseStocksRequest getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest | 

try {
    final result = await api_instance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStocks: $e\n');
}

import org.openapitools.client.api.StocksApi;

public class StocksApiExample {
    public static void main(String[] args) {
        StocksApi apiInstance = new StocksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

        Integer limit = 20; // Integer | Количество значений на одной странице.

        GetWarehouseStocksRequest getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

        try {
            GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StocksApi#getStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
StocksApi *apiInstance = [[StocksApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
 (optional) (default to null)
GetWarehouseStocksRequest *getWarehouseStocksRequest = ; //  (optional)

// Информация об остатках и оборачиваемости
[apiInstance getStocksWith:campaignId
    pageToken:pageToken
    limit:limit
    getWarehouseStocksRequest:getWarehouseStocksRequest
              completionHandler: ^(GetWarehouseStocksResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.StocksApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var opts = {
  'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

  'limit': 20, // {Integer} Количество значений на одной странице.

  'getWarehouseStocksRequest':  // {GetWarehouseStocksRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStocks(campaignId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new StocksApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==;  // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional)  (default to null)
            var limit = 20;  // Integer | Количество значений на одной странице.
 (optional)  (default to null)
            var getWarehouseStocksRequest = new GetWarehouseStocksRequest(); // GetWarehouseStocksRequest |  (optional) 

            try {
                // Информация об остатках и оборачиваемости
                GetWarehouseStocksResponse result = apiInstance.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StocksApi.getStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StocksApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

$limit = 20; // Integer | Количество значений на одной странице.

$getWarehouseStocksRequest = ; // GetWarehouseStocksRequest | 

try {
    $result = $api_instance->getStocks($campaignId, $pageToken, $limit, $getWarehouseStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StocksApi->getStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StocksApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StocksApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.

my $limit = 20; # Integer | Количество значений на одной странице.

my $getWarehouseStocksRequest = WWW::OPenAPIClient::Object::GetWarehouseStocksRequest->new(); # GetWarehouseStocksRequest | 

eval {
    my $result = $api_instance->getStocks(campaignId => $campaignId, pageToken => $pageToken, limit => $limit, getWarehouseStocksRequest => $getWarehouseStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StocksApi->getStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.StocksApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.

Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
 (optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
 (optional) (default to null)
getWarehouseStocksRequest =  # GetWarehouseStocksRequest |  (optional)

try:
    # Информация об остатках и оборачиваемости
    api_response = api_instance.get_stocks(campaignId, pageToken=pageToken, limit=limit, getWarehouseStocksRequest=getWarehouseStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StocksApi->getStocks: %s\n" % e)
extern crate StocksApi;

pub fn main() {
    let campaignId = 789; // Long
    let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
    let limit = 20; // Integer
    let getWarehouseStocksRequest = ; // GetWarehouseStocksRequest

    let mut context = StocksApi::Context::default();
    let result = client.getStocks(campaignId, pageToken, limit, getWarehouseStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
getWarehouseStocksRequest

Query parameters
Name Description
page_token
String
Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
limit
Integer (int32)
Количество значений на одной странице.

Responses


updateStocks

Передача информации об остатках

Передает данные об остатках товаров на витрине. Обязательно указывайте SKU **в точности** так, как он указан в каталоге. Например, _557722_ и _0557722_ — это два разных SKU. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |**⚙️ Лимит:** 100 000 товаров в минуту| |-|


/campaigns/{campaignId}/offers/stocks

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks" \
 -d '{
  "skus" : [ {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  }, {
    "sku" : "sku",
    "items" : [ {
      "count" : 160165638,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StocksApi;

import java.io.File;
import java.util.*;

public class StocksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        StocksApi apiInstance = new StocksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StocksApi#updateStocks");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long campaignId = new Long(); // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

final UpdateStocksRequest updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

try {
    final result = await api_instance.updateStocks(campaignId, updateStocksRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStocks: $e\n');
}

import org.openapitools.client.api.StocksApi;

public class StocksApiExample {
    public static void main(String[] args) {
        StocksApi apiInstance = new StocksApi();
        Long campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

        UpdateStocksRequest updateStocksRequest = ; // UpdateStocksRequest | 

        try {
            EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StocksApi#updateStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
StocksApi *apiInstance = [[StocksApi alloc] init];
Long *campaignId = 789; // Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
UpdateStocksRequest *updateStocksRequest = ; // 

// Передача информации об остатках
[apiInstance updateStocksWith:campaignId
    updateStocksRequest:updateStocksRequest
              completionHandler: ^(EmptyApiResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.StocksApi()
var campaignId = 789; // {Long} Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

var updateStocksRequest = ; // {UpdateStocksRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStocks(campaignId, updateStocksRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class updateStocksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new StocksApi();
            var campaignId = 789;  // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
            var updateStocksRequest = new UpdateStocksRequest(); // UpdateStocksRequest | 

            try {
                // Передача информации об остатках
                EmptyApiResponse result = apiInstance.updateStocks(campaignId, updateStocksRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StocksApi.updateStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StocksApi();
$campaignId = 789; // Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

$updateStocksRequest = ; // UpdateStocksRequest | 

try {
    $result = $api_instance->updateStocks($campaignId, $updateStocksRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StocksApi->updateStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StocksApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StocksApi->new();
my $campaignId = 789; # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

my $updateStocksRequest = WWW::OPenAPIClient::Object::UpdateStocksRequest->new(); # UpdateStocksRequest | 

eval {
    my $result = $api_instance->updateStocks(campaignId => $campaignId, updateStocksRequest => $updateStocksRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StocksApi->updateStocks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.StocksApi()
campaignId = 789 # Long | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)
updateStocksRequest =  # UpdateStocksRequest | 

try:
    # Передача информации об остатках
    api_response = api_instance.update_stocks(campaignId, updateStocksRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StocksApi->updateStocks: %s\n" % e)
extern crate StocksApi;

pub fn main() {
    let campaignId = 789; // Long
    let updateStocksRequest = ; // UpdateStocksRequest

    let mut context = StocksApi::Context::default();
    let result = client.updateStocks(campaignId, updateStocksRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
campaignId*
Long (int64)
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
Body parameters
Name Description
updateStocksRequest *

Responses


Tariffs

calculateTariffs

Калькулятор стоимости услуг

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги. Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг. В запросе можно указать либо параметр `campaignId`, либо `sellingProgram`. Совместное использование параметров приведет к ошибке. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/tariffs/calculate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.partner.market.yandex.ru/tariffs/calculate" \
 -d '{
  "offers" : [ {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  }, {
    "quantity" : 1,
    "price" : 0.6027456183070403,
    "length" : 0.14658129805029452,
    "width" : 0.5962133916683182,
    "weight" : 0.23021358869347652,
    "categoryId" : 0,
    "height" : 0.5637376656633328
  } ],
  "parameters" : {
    "campaignId" : 0,
    "sellingProgram" : "FBY",
    "frequency" : "DAILY"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TariffsApi;

import java.io.File;
import java.util.*;

public class TariffsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        TariffsApi apiInstance = new TariffsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TariffsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CalculateTariffsRequest calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

try {
    final result = await api_instance.calculateTariffs(calculateTariffsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->calculateTariffs: $e\n');
}

import org.openapitools.client.api.TariffsApi;

public class TariffsApiExample {
    public static void main(String[] args) {
        TariffsApi apiInstance = new TariffsApi();
        CalculateTariffsRequest calculateTariffsRequest = ; // CalculateTariffsRequest | 

        try {
            CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TariffsApi#calculateTariffs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
TariffsApi *apiInstance = [[TariffsApi alloc] init];
CalculateTariffsRequest *calculateTariffsRequest = ; // 

// Калькулятор стоимости услуг
[apiInstance calculateTariffsWith:calculateTariffsRequest
              completionHandler: ^(CalculateTariffsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.TariffsApi()
var calculateTariffsRequest = ; // {CalculateTariffsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateTariffs(calculateTariffsRequest, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class calculateTariffsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TariffsApi();
            var calculateTariffsRequest = new CalculateTariffsRequest(); // CalculateTariffsRequest | 

            try {
                // Калькулятор стоимости услуг
                CalculateTariffsResponse result = apiInstance.calculateTariffs(calculateTariffsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TariffsApi.calculateTariffs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TariffsApi();
$calculateTariffsRequest = ; // CalculateTariffsRequest | 

try {
    $result = $api_instance->calculateTariffs($calculateTariffsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TariffsApi->calculateTariffs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TariffsApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TariffsApi->new();
my $calculateTariffsRequest = WWW::OPenAPIClient::Object::CalculateTariffsRequest->new(); # CalculateTariffsRequest | 

eval {
    my $result = $api_instance->calculateTariffs(calculateTariffsRequest => $calculateTariffsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TariffsApi->calculateTariffs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TariffsApi()
calculateTariffsRequest =  # CalculateTariffsRequest | 

try:
    # Калькулятор стоимости услуг
    api_response = api_instance.calculate_tariffs(calculateTariffsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TariffsApi->calculateTariffs: %s\n" % e)
extern crate TariffsApi;

pub fn main() {
    let calculateTariffsRequest = ; // CalculateTariffsRequest

    let mut context = TariffsApi::Context::default();
    let result = client.calculateTariffs(calculateTariffsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Body parameters
Name Description
calculateTariffsRequest *

Responses


Warehouses

getFulfillmentWarehouses

Идентификаторы складов Маркета (FBY)

Возвращает список складов Маркета с их идентификаторами. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WarehousesApi;

import java.io.File;
import java.util.*;

public class WarehousesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        WarehousesApi apiInstance = new WarehousesApi();

        try {
            GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getFulfillmentWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getFulfillmentWarehouses();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFulfillmentWarehouses: $e\n');
}

import org.openapitools.client.api.WarehousesApi;

public class WarehousesApiExample {
    public static void main(String[] args) {
        WarehousesApi apiInstance = new WarehousesApi();

        try {
            GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getFulfillmentWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
WarehousesApi *apiInstance = [[WarehousesApi alloc] init];

// Идентификаторы складов Маркета (FBY)
[apiInstance getFulfillmentWarehousesWithCompletionHandler: 
              ^(GetFulfillmentWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.WarehousesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFulfillmentWarehouses(callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getFulfillmentWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WarehousesApi();

            try {
                // Идентификаторы складов Маркета (FBY)
                GetFulfillmentWarehousesResponse result = apiInstance.getFulfillmentWarehouses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WarehousesApi.getFulfillmentWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WarehousesApi();

try {
    $result = $api_instance->getFulfillmentWarehouses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousesApi->getFulfillmentWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WarehousesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WarehousesApi->new();

eval {
    my $result = $api_instance->getFulfillmentWarehouses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousesApi->getFulfillmentWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WarehousesApi()

try:
    # Идентификаторы складов Маркета (FBY)
    api_response = api_instance.get_fulfillment_warehouses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousesApi->getFulfillmentWarehouses: %s\n" % e)
extern crate WarehousesApi;

pub fn main() {

    let mut context = WarehousesApi::Context::default();
    let result = client.getFulfillmentWarehouses(&context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Responses


getWarehouses

Список складов и групп складов

Возвращает список складов и, если склады объединены, список групп складов. [Что такое группы складов и зачем они нужны](https://yandex.ru/support/marketplace/assortment/operations/stocks.html#unified-stocks) Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов. |**⚙️ Лимит:** 100 запросов в минуту| |-|


/businesses/{businessId}/warehouses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WarehousesApi;

import java.io.File;
import java.util.*;

public class WarehousesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth
        OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
        OAuth.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        WarehousesApi apiInstance = new WarehousesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    final result = await api_instance.getWarehouses(businessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getWarehouses: $e\n');
}

import org.openapitools.client.api.WarehousesApi;

public class WarehousesApiExample {
    public static void main(String[] args) {
        WarehousesApi apiInstance = new WarehousesApi();
        Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


        try {
            GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
WarehousesApi *apiInstance = [[WarehousesApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

// Список складов и групп складов
[apiInstance getWarehousesWith:businessId
              completionHandler: ^(GetWarehousesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new Api.WarehousesApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouses(businessId, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;

namespace Example
{
    public class getWarehousesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WarehousesApi();
            var businessId = 789;  // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

            try {
                // Список складов и групп складов
                GetWarehousesResponse result = apiInstance.getWarehouses(businessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WarehousesApi.getWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WarehousesApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


try {
    $result = $api_instance->getWarehouses($businessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousesApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WarehousesApi;

# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WarehousesApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)


eval {
    my $result = $api_instance->getWarehouses(businessId => $businessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousesApi->getWarehouses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WarehousesApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).

ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
 (default to null)

try:
    # Список складов и групп складов
    api_response = api_instance.get_warehouses(businessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousesApi->getWarehouses: %s\n" % e)
extern crate WarehousesApi;

pub fn main() {
    let businessId = 789; // Long

    let mut context = WarehousesApi::Context::default();
    let result = client.getWarehouses(businessId, &context).wait();

    println!("{:?}", result);
}

Scopes

market:partner-api API Яндекс.Маркета / Поиска по товарам для партнеров

Parameters

Path parameters
Name Description
businessId*
Long (int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required

Responses